Functions
Const ActivityLogApiAxiosParamCreator
- ActivityLogApiAxiosParamCreator(configuration?: Configuration): { getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs> }
getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs>
- (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional startIndex: number
Optional limit: number
Optional minDate: string
Optional hasUserId: boolean
options: any = {}
Returns Promise<RequestArgs>
Const ActivityLogApiFactory
- ActivityLogApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getLogEntries: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getLogEntries: any }
getLogEntries:function
- getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): AxiosPromise<ActivityLogEntryQueryResult>
Parameters
Optional startIndex: number
Optional limit: number
Optional minDate: string
Optional hasUserId: boolean
Optional options: any
Const ActivityLogApiFp
- ActivityLogApiFp(configuration?: Configuration): { getLogEntries: any }
Parameters
Returns { getLogEntries: any }
getLogEntries:function
- getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>
Parameters
Optional startIndex: number
Optional limit: number
Optional minDate: string
Optional hasUserId: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>
Const ApiKeyApiAxiosParamCreator
- ApiKeyApiAxiosParamCreator(configuration?: Configuration): { createKey: (app: string, options?: any) => Promise<RequestArgs>; getKeys: (options?: any) => Promise<RequestArgs>; revokeKey: (key: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { createKey: (app: string, options?: any) => Promise<RequestArgs>; getKeys: (options?: any) => Promise<RequestArgs>; revokeKey: (key: string, options?: any) => Promise<RequestArgs> }
createKey: (app: string, options?: any) => Promise<RequestArgs>
- (app: string, options?: any): Promise<RequestArgs>
Parameters
app: string
options: any = {}
Returns Promise<RequestArgs>
getKeys: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
revokeKey: (key: string, options?: any) => Promise<RequestArgs>
- (key: string, options?: any): Promise<RequestArgs>
Parameters
key: string
options: any = {}
Returns Promise<RequestArgs>
Const ApiKeyApiFactory
- ApiKeyApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createKey: any; getKeys: any; revokeKey: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { createKey: any; getKeys: any; revokeKey: any }
createKey:function
- createKey(app: string, options?: any): AxiosPromise<void>
Parameters
app: string
Optional options: any
Returns AxiosPromise<void>
getKeys:function
revokeKey:function
- revokeKey(key: string, options?: any): AxiosPromise<void>
Parameters
key: string
Optional options: any
Returns AxiosPromise<void>
Const ApiKeyApiFp
- ApiKeyApiFp(configuration?: Configuration): { createKey: any; getKeys: any; revokeKey: any }
Parameters
Returns { createKey: any; getKeys: any; revokeKey: any }
createKey:function
- createKey(app: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
app: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getKeys:function
revokeKey:function
- revokeKey(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
key: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ArtistsApiAxiosParamCreator
- ArtistsApiAxiosParamCreator(configuration?: Configuration): { getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
- (name: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
Const ArtistsApiFactory
- ArtistsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAlbumArtists: any; getArtistByName: any; getArtists: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getAlbumArtists: any; getArtistByName: any; getArtists: any }
getAlbumArtists:function
- getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
getArtistByName:function
- getArtistByName(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
name: string
Optional userId: string
Optional options: any
getArtists:function
- getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Const ArtistsApiFp
- ArtistsApiFp(configuration?: Configuration): { getAlbumArtists: any; getArtistByName: any; getArtists: any }
Parameters
Returns { getAlbumArtists: any; getArtistByName: any; getArtists: any }
getAlbumArtists:function
- getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getArtistByName:function
- getArtistByName(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
name: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getArtists:function
- getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional minCommunityRating: number
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional genres: string[]
Optional genreIds: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional studioIds: string[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const AudioApiAxiosParamCreator
- AudioApiAxiosParamCreator(configuration?: Configuration): { getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs> }
getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
Const AudioApiFactory
- AudioApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
getAudioStream:function
- getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
getAudioStreamByContainer:function
- getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
headAudioStream:function
- headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
headAudioStreamByContainer:function
- headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
Const AudioApiFp
- AudioApiFp(configuration?: Configuration): { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
Parameters
Returns { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
getAudioStream:function
- getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getAudioStreamByContainer:function
- getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headAudioStream:function
- headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headAudioStreamByContainer:function
- headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const BrandingApiAxiosParamCreator
- BrandingApiAxiosParamCreator(configuration?: Configuration): { getBrandingCss: (options?: any) => Promise<RequestArgs>; getBrandingCss2: (options?: any) => Promise<RequestArgs>; getBrandingOptions: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { getBrandingCss: (options?: any) => Promise<RequestArgs>; getBrandingCss2: (options?: any) => Promise<RequestArgs>; getBrandingOptions: (options?: any) => Promise<RequestArgs> }
getBrandingCss: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getBrandingCss2: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getBrandingOptions: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const BrandingApiFactory
- BrandingApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
getBrandingCss:function
- getBrandingCss(options?: any): AxiosPromise<string>
Parameters
Returns AxiosPromise<string>
getBrandingCss2:function
- getBrandingCss2(options?: any): AxiosPromise<string>
Parameters
Returns AxiosPromise<string>
getBrandingOptions:function
Const BrandingApiFp
- BrandingApiFp(configuration?: Configuration): { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
Parameters
Returns { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
getBrandingCss:function
- getBrandingCss(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
getBrandingCss2:function
- getBrandingCss2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
getBrandingOptions:function
- getBrandingOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptions>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptions>>
Const ChannelsApiAxiosParamCreator
- ChannelsApiAxiosParamCreator(configuration?: Configuration): { getAllChannelFeatures: (options?: any) => Promise<RequestArgs>; getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>; getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { getAllChannelFeatures: (options?: any) => Promise<RequestArgs>; getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>; getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs> }
getAllChannelFeatures: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>
- (channelId: string, options?: any): Promise<RequestArgs>
Parameters
channelId: string
options: any = {}
Returns Promise<RequestArgs>
getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
channelId: string
Optional folderId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional sortBy: string[]
options: any = {}
Returns Promise<RequestArgs>
getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional supportsLatestItems: boolean
Optional supportsMediaDeletion: boolean
Optional isFavorite: boolean
options: any = {}
Returns Promise<RequestArgs>
getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs>
- (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional channelIds: string[]
options: any = {}
Returns Promise<RequestArgs>
Const ChannelsApiFactory
- ChannelsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
getAllChannelFeatures:function
getChannelFeatures:function
- getChannelFeatures(channelId: string, options?: any): AxiosPromise<ChannelFeatures>
Parameters
channelId: string
Optional options: any
getChannelItems:function
Parameters
channelId: string
Optional folderId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional sortBy: string[]
Optional options: any
getChannels:function
- getChannels(userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional supportsLatestItems: boolean
Optional supportsMediaDeletion: boolean
Optional isFavorite: boolean
Optional options: any
getLatestChannelItems:function
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional channelIds: string[]
Optional options: any
Const ChannelsApiFp
- ChannelsApiFp(configuration?: Configuration): { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
Parameters
Returns { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
getAllChannelFeatures:function
- getAllChannelFeatures(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures[]>>
getChannelFeatures:function
- getChannelFeatures(channelId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures>>
Parameters
channelId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures>>
getChannelItems:function
- getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
channelId: string
Optional folderId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional sortBy: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getChannels:function
- getChannels(userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional supportsLatestItems: boolean
Optional supportsMediaDeletion: boolean
Optional isFavorite: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getLatestChannelItems:function
- getLatestChannelItems(userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional channelIds: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const CollectionApiAxiosParamCreator
- CollectionApiAxiosParamCreator(configuration?: Configuration): { addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>; createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>; removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>; createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>; removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs> }
addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>
- (collectionId: string, ids: string[], options?: any): Promise<RequestArgs>
Parameters
collectionId: string
ids: string[]
options: any = {}
Returns Promise<RequestArgs>
createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>
- (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
Optional ids: string[]
Optional parentId: string
Optional isLocked: boolean
options: any = {}
Returns Promise<RequestArgs>
removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>
- (collectionId: string, ids: string[], options?: any): Promise<RequestArgs>
Parameters
collectionId: string
ids: string[]
options: any = {}
Returns Promise<RequestArgs>
Const CollectionApiFactory
- CollectionApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addToCollection: any; createCollection: any; removeFromCollection: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { addToCollection: any; createCollection: any; removeFromCollection: any }
addToCollection:function
- addToCollection(collectionId: string, ids: string[], options?: any): AxiosPromise<void>
Parameters
collectionId: string
ids: string[]
Optional options: any
Returns AxiosPromise<void>
createCollection:function
- createCollection(name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): AxiosPromise<CollectionCreationResult>
Parameters
Optional name: string
Optional ids: string[]
Optional parentId: string
Optional isLocked: boolean
Optional options: any
removeFromCollection:function
- removeFromCollection(collectionId: string, ids: string[], options?: any): AxiosPromise<void>
Parameters
collectionId: string
ids: string[]
Optional options: any
Returns AxiosPromise<void>
Const CollectionApiFp
- CollectionApiFp(configuration?: Configuration): { addToCollection: any; createCollection: any; removeFromCollection: any }
Parameters
Returns { addToCollection: any; createCollection: any; removeFromCollection: any }
addToCollection:function
- addToCollection(collectionId: string, ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
collectionId: string
ids: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
createCollection:function
- createCollection(name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>>
Parameters
Optional name: string
Optional ids: string[]
Optional parentId: string
Optional isLocked: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>>
removeFromCollection:function
- removeFromCollection(collectionId: string, ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
collectionId: string
ids: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ConfigurationApiAxiosParamCreator
- ConfigurationApiAxiosParamCreator(configuration?: Configuration): { getConfiguration: (options?: any) => Promise<RequestArgs>; getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>; getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>; updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>; updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>; updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getConfiguration: (options?: any) => Promise<RequestArgs>; getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>; getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>; updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>; updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>; updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs> }
getConfiguration: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>
- (key: string, options?: any): Promise<RequestArgs>
Parameters
key: string
options: any = {}
Returns Promise<RequestArgs>
updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>
- (key: string, options?: any): Promise<RequestArgs>
Parameters
key: string
options: any = {}
Returns Promise<RequestArgs>
Const ConfigurationApiFactory
- ConfigurationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
getConfiguration:function
getDefaultMetadataOptions:function
getNamedConfiguration:function
- getNamedConfiguration(key: string, options?: any): AxiosPromise<any>
Parameters
key: string
Optional options: any
Returns AxiosPromise<any>
updateConfiguration:function
- updateConfiguration(serverConfiguration: ServerConfiguration, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
updateMediaEncoderPath:function
- updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
updateNamedConfiguration:function
- updateNamedConfiguration(key: string, options?: any): AxiosPromise<void>
Parameters
key: string
Optional options: any
Returns AxiosPromise<void>
Const ConfigurationApiFp
- ConfigurationApiFp(configuration?: Configuration): { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
Parameters
Returns { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
getConfiguration:function
- getConfiguration(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>>
getDefaultMetadataOptions:function
- getDefaultMetadataOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>>
getNamedConfiguration:function
- getNamedConfiguration(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
key: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
updateConfiguration:function
- updateConfiguration(serverConfiguration: ServerConfiguration, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateMediaEncoderPath:function
- updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateNamedConfiguration:function
- updateNamedConfiguration(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
key: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const DashboardApiAxiosParamCreator
- DashboardApiAxiosParamCreator(configuration?: Configuration): { getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>; getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>; getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs> }
getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>
Parameters
Optional enableInMainMenu: boolean
options: any = {}
Returns Promise<RequestArgs>
getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs>
- (name?: string, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
options: any = {}
Returns Promise<RequestArgs>
Const DashboardApiFactory
- DashboardApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConfigurationPages: any; getDashboardConfigurationPage: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getConfigurationPages: any; getDashboardConfigurationPage: any }
getConfigurationPages:function
Parameters
Optional enableInMainMenu: boolean
Optional options: any
getDashboardConfigurationPage:function
- getDashboardConfigurationPage(name?: string, options?: any): AxiosPromise<any>
Parameters
Optional name: string
Optional options: any
Returns AxiosPromise<any>
Const DashboardApiFp
- DashboardApiFp(configuration?: Configuration): { getConfigurationPages: any; getDashboardConfigurationPage: any }
Parameters
Returns { getConfigurationPages: any; getDashboardConfigurationPage: any }
getConfigurationPages:function
Parameters
Optional enableInMainMenu: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>>
getDashboardConfigurationPage:function
- getDashboardConfigurationPage(name?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
Optional name: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const DevicesApiAxiosParamCreator
- DevicesApiAxiosParamCreator(configuration?: Configuration): { deleteDevice: (id: string, options?: any) => Promise<RequestArgs>; getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>; getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>; getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>; updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteDevice: (id: string, options?: any) => Promise<RequestArgs>; getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>; getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>; getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>; updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs> }
deleteDevice: (id: string, options?: any) => Promise<RequestArgs>
- (id: string, options?: any): Promise<RequestArgs>
Parameters
id: string
options: any = {}
Returns Promise<RequestArgs>
getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>
- (id: string, options?: any): Promise<RequestArgs>
Parameters
id: string
options: any = {}
Returns Promise<RequestArgs>
getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>
- (id: string, options?: any): Promise<RequestArgs>
Parameters
id: string
options: any = {}
Returns Promise<RequestArgs>
getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>
- (supportsSync?: boolean, userId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional supportsSync: boolean
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs>
- (id: string, deviceOptions: DeviceOptions, options?: any): Promise<RequestArgs>
Parameters
id: string
options: any = {}
Returns Promise<RequestArgs>
Const DevicesApiFactory
- DevicesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
deleteDevice:function
- deleteDevice(id: string, options?: any): AxiosPromise<void>
Parameters
id: string
Optional options: any
Returns AxiosPromise<void>
getDeviceInfo:function
- getDeviceInfo(id: string, options?: any): AxiosPromise<DeviceInfo>
Parameters
id: string
Optional options: any
Returns AxiosPromise<DeviceInfo>
getDeviceOptions:function
- getDeviceOptions(id: string, options?: any): AxiosPromise<DeviceOptions>
Parameters
id: string
Optional options: any
getDevices:function
Parameters
Optional supportsSync: boolean
Optional userId: string
Optional options: any
updateDeviceOptions:function
- updateDeviceOptions(id: string, deviceOptions: DeviceOptions, options?: any): AxiosPromise<void>
Parameters
id: string
Optional options: any
Returns AxiosPromise<void>
Const DevicesApiFp
- DevicesApiFp(configuration?: Configuration): { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
Parameters
Returns { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
deleteDevice:function
- deleteDevice(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getDeviceInfo:function
- getDeviceInfo(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>>
Parameters
id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>>
getDeviceOptions:function
- getDeviceOptions(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptions>>
Parameters
id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptions>>
getDevices:function
- getDevices(supportsSync?: boolean, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoQueryResult>>
Parameters
Optional supportsSync: boolean
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoQueryResult>>
updateDeviceOptions:function
- updateDeviceOptions(id: string, deviceOptions: DeviceOptions, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const DisplayPreferencesApiAxiosParamCreator
- DisplayPreferencesApiAxiosParamCreator(configuration?: Configuration): { getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>; updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>; updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs> }
getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>
- (displayPreferencesId: string, userId: string, client: string, options?: any): Promise<RequestArgs>
Parameters
displayPreferencesId: string
userId: string
client: string
options: any = {}
Returns Promise<RequestArgs>
updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs>
- (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): Promise<RequestArgs>
Parameters
displayPreferencesId: string
userId: string
client: string
options: any = {}
Returns Promise<RequestArgs>
Const DisplayPreferencesApiFactory
- DisplayPreferencesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getDisplayPreferences: any; updateDisplayPreferences: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getDisplayPreferences: any; updateDisplayPreferences: any }
getDisplayPreferences:function
- getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: any): AxiosPromise<DisplayPreferencesDto>
Parameters
displayPreferencesId: string
userId: string
client: string
Optional options: any
updateDisplayPreferences:function
- updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): AxiosPromise<void>
Parameters
displayPreferencesId: string
userId: string
client: string
Optional options: any
Returns AxiosPromise<void>
Const DisplayPreferencesApiFp
- DisplayPreferencesApiFp(configuration?: Configuration): { getDisplayPreferences: any; updateDisplayPreferences: any }
Parameters
Returns { getDisplayPreferences: any; updateDisplayPreferences: any }
getDisplayPreferences:function
- getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayPreferencesDto>>
Parameters
displayPreferencesId: string
userId: string
client: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayPreferencesDto>>
updateDisplayPreferences:function
- updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
displayPreferencesId: string
userId: string
client: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const DlnaApiAxiosParamCreator
- DlnaApiAxiosParamCreator(configuration?: Configuration): { createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>; deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getDefaultProfile: (options?: any) => Promise<RequestArgs>; getProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getProfileInfos: (options?: any) => Promise<RequestArgs>; updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs> }
Parameters
Returns { createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>; deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getDefaultProfile: (options?: any) => Promise<RequestArgs>; getProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getProfileInfos: (options?: any) => Promise<RequestArgs>; updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs> }
createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>
- (deviceProfile?: DeviceProfile, options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>
- (profileId: string, options?: any): Promise<RequestArgs>
Parameters
profileId: string
options: any = {}
Returns Promise<RequestArgs>
getDefaultProfile: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getProfile: (profileId: string, options?: any) => Promise<RequestArgs>
- (profileId: string, options?: any): Promise<RequestArgs>
Parameters
profileId: string
options: any = {}
Returns Promise<RequestArgs>
getProfileInfos: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>
- (profileId: string, deviceProfile?: DeviceProfile, options?: any): Promise<RequestArgs>
Parameters
profileId: string
options: any = {}
Returns Promise<RequestArgs>
Const DlnaApiFactory
- DlnaApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
createProfile:function
- createProfile(deviceProfile?: DeviceProfile, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
deleteProfile:function
- deleteProfile(profileId: string, options?: any): AxiosPromise<void>
Parameters
profileId: string
Optional options: any
Returns AxiosPromise<void>
getDefaultProfile:function
getProfile:function
- getProfile(profileId: string, options?: any): AxiosPromise<DeviceProfile>
Parameters
profileId: string
Optional options: any
getProfileInfos:function
updateProfile:function
- updateProfile(profileId: string, deviceProfile?: DeviceProfile, options?: any): AxiosPromise<void>
Parameters
profileId: string
Optional options: any
Returns AxiosPromise<void>
Const DlnaApiFp
- DlnaApiFp(configuration?: Configuration): { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
Parameters
Returns { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
createProfile:function
- createProfile(deviceProfile?: DeviceProfile, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteProfile:function
- deleteProfile(profileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
profileId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getDefaultProfile:function
- getDefaultProfile(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
getProfile:function
- getProfile(profileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
Parameters
profileId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
getProfileInfos:function
- getProfileInfos(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfileInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfileInfo[]>>
updateProfile:function
- updateProfile(profileId: string, deviceProfile?: DeviceProfile, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
profileId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const DlnaServerApiAxiosParamCreator
- DlnaServerApiAxiosParamCreator(configuration?: Configuration): { getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>; getIcon: (fileName: string, options?: any) => Promise<RequestArgs>; getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>; processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>; getIcon: (fileName: string, options?: any) => Promise<RequestArgs>; getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>; processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs> }
getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getIcon: (fileName: string, options?: any) => Promise<RequestArgs>
- (fileName: string, options?: any): Promise<RequestArgs>
Parameters
fileName: string
options: any = {}
Returns Promise<RequestArgs>
getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>
- (serverId: string, fileName: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
fileName: string
options: any = {}
Returns Promise<RequestArgs>
getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
- (serverId: string, options?: any): Promise<RequestArgs>
Parameters
serverId: string
options: any = {}
Returns Promise<RequestArgs>
Const DlnaServerApiFactory
- DlnaServerApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
getConnectionManager:function
- getConnectionManager(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getConnectionManager2:function
- getConnectionManager2(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getConnectionManager3:function
- getConnectionManager3(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getContentDirectory:function
- getContentDirectory(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getContentDirectory2:function
- getContentDirectory2(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getContentDirectory3:function
- getContentDirectory3(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getDescriptionXml:function
- getDescriptionXml(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getDescriptionXml2:function
- getDescriptionXml2(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getIcon:function
- getIcon(fileName: string, options?: any): AxiosPromise<any>
Parameters
fileName: string
Optional options: any
Returns AxiosPromise<any>
getIconId:function
- getIconId(serverId: string, fileName: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
fileName: string
Optional options: any
Returns AxiosPromise<any>
getMediaReceiverRegistrar:function
- getMediaReceiverRegistrar(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getMediaReceiverRegistrar2:function
- getMediaReceiverRegistrar2(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
getMediaReceiverRegistrar3:function
- getMediaReceiverRegistrar3(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
processConnectionManagerControlRequest:function
- processConnectionManagerControlRequest(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
processContentDirectoryControlRequest:function
- processContentDirectoryControlRequest(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
processMediaReceiverRegistrarControlRequest:function
- processMediaReceiverRegistrarControlRequest(serverId: string, options?: any): AxiosPromise<any>
Parameters
serverId: string
Optional options: any
Returns AxiosPromise<any>
Const DlnaServerApiFp
- DlnaServerApiFp(configuration?: Configuration): { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
Parameters
Returns { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
getConnectionManager:function
- getConnectionManager(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getConnectionManager2:function
- getConnectionManager2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getConnectionManager3:function
- getConnectionManager3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getContentDirectory:function
- getContentDirectory(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getContentDirectory2:function
- getContentDirectory2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getContentDirectory3:function
- getContentDirectory3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getDescriptionXml:function
- getDescriptionXml(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getDescriptionXml2:function
- getDescriptionXml2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getIcon:function
- getIcon(fileName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
fileName: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getIconId:function
- getIconId(serverId: string, fileName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
fileName: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMediaReceiverRegistrar:function
- getMediaReceiverRegistrar(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMediaReceiverRegistrar2:function
- getMediaReceiverRegistrar2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMediaReceiverRegistrar3:function
- getMediaReceiverRegistrar3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
processConnectionManagerControlRequest:function
- processConnectionManagerControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
processContentDirectoryControlRequest:function
- processContentDirectoryControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
processMediaReceiverRegistrarControlRequest:function
- processMediaReceiverRegistrarControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
serverId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const DynamicHlsApiAxiosParamCreator
- DynamicHlsApiAxiosParamCreator(configuration?: Configuration): { getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs> }
getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
options: any = {}
Returns Promise<RequestArgs>
getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
options: any = {}
Returns Promise<RequestArgs>
getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
options: any = {}
Returns Promise<RequestArgs>
headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
options: any = {}
Returns Promise<RequestArgs>
Const DynamicHlsApiFactory
- DynamicHlsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
getHlsAudioSegment:function
- getHlsAudioSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
getHlsVideoSegment:function
- getHlsVideoSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
getMasterHlsAudioPlaylist:function
- getMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns AxiosPromise<any>
getMasterHlsVideoPlaylist:function
- getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns AxiosPromise<any>
getVariantHlsAudioPlaylist:function
- getVariantHlsAudioPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
getVariantHlsVideoPlaylist:function
- getVariantHlsVideoPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
headMasterHlsAudioPlaylist:function
- headMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns AxiosPromise<any>
headMasterHlsVideoPlaylist:function
- headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns AxiosPromise<any>
Const DynamicHlsApiFp
- DynamicHlsApiFp(configuration?: Configuration): { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
Parameters
Returns { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
getHlsAudioSegment:function
- getHlsAudioSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getHlsVideoSegment:function
- getHlsVideoSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
playlistId: string
segmentId: number
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMasterHlsAudioPlaylist:function
- getMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMasterHlsVideoPlaylist:function
- getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getVariantHlsAudioPlaylist:function
- getVariantHlsAudioPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getVariantHlsVideoPlaylist:function
- getVariantHlsVideoPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headMasterHlsAudioPlaylist:function
- headMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headMasterHlsVideoPlaylist:function
- headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
mediaSourceId: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional enableAdaptiveBitrateStreaming: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const EnvironmentApiAxiosParamCreator
- EnvironmentApiAxiosParamCreator(configuration?: Configuration): { getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>; getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>; getDrives: (options?: any) => Promise<RequestArgs>; getNetworkShares: (options?: any) => Promise<RequestArgs>; getParentPath: (path: string, options?: any) => Promise<RequestArgs>; validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>; getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>; getDrives: (options?: any) => Promise<RequestArgs>; getNetworkShares: (options?: any) => Promise<RequestArgs>; getParentPath: (path: string, options?: any) => Promise<RequestArgs>; validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs> }
getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>
- (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): Promise<RequestArgs>
Parameters
path: string
Optional includeFiles: boolean
Optional includeDirectories: boolean
options: any = {}
Returns Promise<RequestArgs>
getDrives: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getNetworkShares: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getParentPath: (path: string, options?: any) => Promise<RequestArgs>
- (path: string, options?: any): Promise<RequestArgs>
Parameters
path: string
options: any = {}
Returns Promise<RequestArgs>
validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const EnvironmentApiFactory
- EnvironmentApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
getDefaultDirectoryBrowser:function
getDirectoryContents:function
- getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): AxiosPromise<FileSystemEntryInfo[]>
Parameters
path: string
Optional includeFiles: boolean
Optional includeDirectories: boolean
Optional options: any
getDrives:function
getNetworkShares:function
getParentPath:function
- getParentPath(path: string, options?: any): AxiosPromise<string>
Parameters
path: string
Optional options: any
Returns AxiosPromise<string>
validatePath:function
- validatePath(validatePathDto: ValidatePathDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const EnvironmentApiFp
- EnvironmentApiFp(configuration?: Configuration): { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
Parameters
Returns { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
getDefaultDirectoryBrowser:function
getDirectoryContents:function
- getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
Parameters
path: string
Optional includeFiles: boolean
Optional includeDirectories: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
getDrives:function
- getDrives(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
getNetworkShares:function
- getNetworkShares(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
getParentPath:function
- getParentPath(path: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
Parameters
path: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
validatePath:function
- validatePath(validatePathDto: ValidatePathDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const FilterApiAxiosParamCreator
- FilterApiAxiosParamCreator(configuration?: Configuration): { getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>; getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>; getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs> }
getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isAiring: boolean
Optional isMovie: boolean
Optional isSports: boolean
Optional isKids: boolean
Optional isNews: boolean
Optional isSeries: boolean
Optional recursive: boolean
options: any = {}
Returns Promise<RequestArgs>
getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs>
- (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
options: any = {}
Returns Promise<RequestArgs>
Const FilterApiFactory
- FilterApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getQueryFilters: any; getQueryFiltersLegacy: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getQueryFilters: any; getQueryFiltersLegacy: any }
getQueryFilters:function
- getQueryFilters(userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): AxiosPromise<QueryFilters>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isAiring: boolean
Optional isMovie: boolean
Optional isSports: boolean
Optional isKids: boolean
Optional isNews: boolean
Optional isSeries: boolean
Optional recursive: boolean
Optional options: any
getQueryFiltersLegacy:function
- getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): AxiosPromise<QueryFiltersLegacy>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
Optional options: any
Const FilterApiFp
- FilterApiFp(configuration?: Configuration): { getQueryFilters: any; getQueryFiltersLegacy: any }
Parameters
Returns { getQueryFilters: any; getQueryFiltersLegacy: any }
getQueryFilters:function
- getQueryFilters(userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isAiring: boolean
Optional isMovie: boolean
Optional isSports: boolean
Optional isKids: boolean
Optional isNews: boolean
Optional isSeries: boolean
Optional recursive: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>>
getQueryFiltersLegacy:function
- getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>>
Parameters
Optional userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>>
Const GenresApiAxiosParamCreator
- GenresApiAxiosParamCreator(configuration?: Configuration): { getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>
- (genreName: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
genreName: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
Const GenresApiFactory
- GenresApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGenre: any; getGenres: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getGenre: any; getGenres: any }
getGenre:function
- getGenre(genreName: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
genreName: string
Optional userId: string
Optional options: any
getGenres:function
- getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Const GenresApiFp
- GenresApiFp(configuration?: Configuration): { getGenre: any; getGenres: any }
Parameters
Returns { getGenre: any; getGenres: any }
getGenre:function
- getGenre(genreName: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
genreName: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getGenres:function
- getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const HlsSegmentApiAxiosParamCreator
- HlsSegmentApiAxiosParamCreator(configuration?: Configuration): { getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>; getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>; stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>; getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>; stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs> }
getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, segmentId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
segmentId: string
options: any = {}
Returns Promise<RequestArgs>
getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, segmentId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
segmentId: string
options: any = {}
Returns Promise<RequestArgs>
getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, playlistId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
playlistId: string
options: any = {}
Returns Promise<RequestArgs>
getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>
- (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
playlistId: string
segmentId: string
segmentContainer: string
options: any = {}
Returns Promise<RequestArgs>
stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs>
- (deviceId: string, playSessionId: string, options?: any): Promise<RequestArgs>
Parameters
deviceId: string
playSessionId: string
options: any = {}
Returns Promise<RequestArgs>
Const HlsSegmentApiFactory
- HlsSegmentApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
getHlsAudioSegmentLegacyAac:function
- getHlsAudioSegmentLegacyAac(itemId: string, segmentId: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
segmentId: string
Optional options: any
Returns AxiosPromise<any>
getHlsAudioSegmentLegacyMp3:function
- getHlsAudioSegmentLegacyMp3(itemId: string, segmentId: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
segmentId: string
Optional options: any
Returns AxiosPromise<any>
getHlsPlaylistLegacy:function
- getHlsPlaylistLegacy(itemId: string, playlistId: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
playlistId: string
Optional options: any
Returns AxiosPromise<any>
getHlsVideoSegmentLegacy:function
- getHlsVideoSegmentLegacy(itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
playlistId: string
segmentId: string
segmentContainer: string
Optional options: any
Returns AxiosPromise<any>
stopEncodingProcess:function
- stopEncodingProcess(deviceId: string, playSessionId: string, options?: any): AxiosPromise<void>
Parameters
deviceId: string
playSessionId: string
Optional options: any
Returns AxiosPromise<void>
Const HlsSegmentApiFp
- HlsSegmentApiFp(configuration?: Configuration): { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
Parameters
Returns { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
getHlsAudioSegmentLegacyAac:function
- getHlsAudioSegmentLegacyAac(itemId: string, segmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
segmentId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getHlsAudioSegmentLegacyMp3:function
- getHlsAudioSegmentLegacyMp3(itemId: string, segmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
segmentId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getHlsPlaylistLegacy:function
- getHlsPlaylistLegacy(itemId: string, playlistId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
playlistId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getHlsVideoSegmentLegacy:function
- getHlsVideoSegmentLegacy(itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
playlistId: string
segmentId: string
segmentContainer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
stopEncodingProcess:function
- stopEncodingProcess(deviceId: string, playSessionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
deviceId: string
playSessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ImageApiAxiosParamCreator
- ImageApiAxiosParamCreator(configuration?: Configuration): { deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>; deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>; deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>; deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>; getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>; postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>; setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>; setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>; updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>; deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>; deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>; deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>; getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>; postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>; setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>; setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>; updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs> }
deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, index?: number, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional index: number
options: any = {}
Returns Promise<RequestArgs>
deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, index: number, options?: any): Promise<RequestArgs>
Parameters
userId: string
index: number
options: any = {}
Returns Promise<RequestArgs>
getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
options: any = {}
Returns Promise<RequestArgs>
headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
options: any = {}
Returns Promise<RequestArgs>
postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, index?: number, body?: any, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional index: number
Optional body: any
options: any = {}
Returns Promise<RequestArgs>
postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>
- (userId: string, imageType: ImageType, index: number, body?: any, options?: any): Promise<RequestArgs>
Parameters
userId: string
index: number
Optional body: any
options: any = {}
Returns Promise<RequestArgs>
setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, body?: any, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional body: any
options: any = {}
Returns Promise<RequestArgs>
setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): Promise<RequestArgs>
Parameters
itemId: string
imageIndex: number
Optional body: any
options: any = {}
Returns Promise<RequestArgs>
updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs>
- (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
imageIndex: number
newIndex: number
options: any = {}
Returns Promise<RequestArgs>
Const ImageApiFactory
- ImageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
deleteItemImage:function
- deleteItemImage(itemId: string, imageType: ImageType, imageIndex?: number, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<void>
deleteItemImageByIndex:function
- deleteItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, options?: any): AxiosPromise<void>
Parameters
itemId: string
imageIndex: number
Optional options: any
Returns AxiosPromise<void>
deleteUserImage:function
- deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional index: number
Optional options: any
Returns AxiosPromise<void>
deleteUserImageByIndex:function
- deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: any): AxiosPromise<void>
Parameters
userId: string
index: number
Optional options: any
Returns AxiosPromise<void>
getArtistImage:function
- getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getGenreImage:function
- getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getGenreImageByIndex:function
- getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getItemImage:function
- getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getItemImage2:function
- getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getItemImageByIndex:function
- getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getItemImageInfos:function
- getItemImageInfos(itemId: string, options?: any): AxiosPromise<ImageInfo[]>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<ImageInfo[]>
getMusicGenreImage:function
- getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getMusicGenreImageByIndex:function
- getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getPersonImage:function
- getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getPersonImageByIndex:function
- getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getStudioImage:function
- getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getStudioImageByIndex:function
- getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
getUserImage:function
- getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
getUserImageByIndex:function
- getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headArtistImage:function
- headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headGenreImage:function
- headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headGenreImageByIndex:function
- headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headItemImage:function
- headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headItemImage2:function
- headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headItemImageByIndex:function
- headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headMusicGenreImage:function
- headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headMusicGenreImageByIndex:function
- headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headPersonImage:function
- headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headPersonImageByIndex:function
- headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headStudioImage:function
- headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headStudioImageByIndex:function
- headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
headUserImage:function
- headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns AxiosPromise<any>
headUserImageByIndex:function
- headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns AxiosPromise<any>
postUserImage:function
- postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional index: number
Optional body: any
Optional options: any
Returns AxiosPromise<void>
postUserImageByIndex:function
- postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: any): AxiosPromise<void>
Parameters
userId: string
index: number
Optional body: any
Optional options: any
Returns AxiosPromise<void>
setItemImage:function
- setItemImage(itemId: string, imageType: ImageType, body?: any, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional body: any
Optional options: any
Returns AxiosPromise<void>
setItemImageByIndex:function
- setItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): AxiosPromise<void>
Parameters
itemId: string
imageIndex: number
Optional body: any
Optional options: any
Returns AxiosPromise<void>
updateItemImageIndex:function
- updateItemImageIndex(itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): AxiosPromise<void>
Parameters
itemId: string
imageIndex: number
newIndex: number
Optional options: any
Returns AxiosPromise<void>
Const ImageApiFp
- ImageApiFp(configuration?: Configuration): { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
Parameters
Returns { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
deleteItemImage:function
- deleteItemImage(itemId: string, imageType: ImageType, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteItemImageByIndex:function
- deleteItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteUserImage:function
- deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional index: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteUserImageByIndex:function
- deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
index: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getArtistImage:function
- getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getGenreImage:function
- getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getGenreImageByIndex:function
- getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getItemImage:function
- getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getItemImage2:function
- getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getItemImageByIndex:function
- getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getItemImageInfos:function
- getItemImageInfos(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>>
getMusicGenreImage:function
- getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMusicGenreImageByIndex:function
- getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getPersonImage:function
- getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getPersonImageByIndex:function
- getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getStudioImage:function
- getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getStudioImageByIndex:function
- getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getUserImage:function
- getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getUserImageByIndex:function
- getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headArtistImage:function
- headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headGenreImage:function
- headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headGenreImageByIndex:function
- headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headItemImage:function
- headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headItemImage2:function
- headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
maxWidth: number
maxHeight: number
tag: string
percentPlayed: number
unplayedCount: number
imageIndex: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headItemImageByIndex:function
- headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
imageIndex: number
Optional maxWidth: number
Optional maxHeight: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional tag: string
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional percentPlayed: number
Optional unplayedCount: number
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headMusicGenreImage:function
- headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headMusicGenreImageByIndex:function
- headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headPersonImage:function
- headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headPersonImageByIndex:function
- headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headStudioImage:function
- headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headStudioImageByIndex:function
- headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headUserImage:function
- headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
userId: string
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional imageIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headUserImageByIndex:function
- headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
userId: string
imageIndex: number
Optional tag: string
Optional maxWidth: number
Optional maxHeight: number
Optional percentPlayed: number
Optional unplayedCount: number
Optional width: number
Optional height: number
Optional quality: number
Optional fillWidth: number
Optional fillHeight: number
Optional cropWhitespace: boolean
Optional addPlayedIndicator: boolean
Optional blur: number
Optional backgroundColor: string
Optional foregroundLayer: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
postUserImage:function
- postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional index: number
Optional body: any
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postUserImageByIndex:function
- postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
index: number
Optional body: any
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
setItemImage:function
- setItemImage(itemId: string, imageType: ImageType, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional body: any
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
setItemImageByIndex:function
- setItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
imageIndex: number
Optional body: any
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateItemImageIndex:function
- updateItemImageIndex(itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
imageIndex: number
newIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ImageByNameApiAxiosParamCreator
- ImageByNameApiAxiosParamCreator(configuration?: Configuration): { getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>; getGeneralImages: (options?: any) => Promise<RequestArgs>; getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getMediaInfoImages: (options?: any) => Promise<RequestArgs>; getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getRatingImages: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>; getGeneralImages: (options?: any) => Promise<RequestArgs>; getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getMediaInfoImages: (options?: any) => Promise<RequestArgs>; getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getRatingImages: (options?: any) => Promise<RequestArgs> }
getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>
- (name: string, type: string, options?: any): Promise<RequestArgs>
Parameters
name: string
type: string
options: any = {}
Returns Promise<RequestArgs>
getGeneralImages: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>
- (theme: string, name: string, options?: any): Promise<RequestArgs>
Parameters
theme: string
name: string
options: any = {}
Returns Promise<RequestArgs>
getMediaInfoImages: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>
- (theme: string, name: string, options?: any): Promise<RequestArgs>
Parameters
theme: string
name: string
options: any = {}
Returns Promise<RequestArgs>
getRatingImages: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const ImageByNameApiFactory
- ImageByNameApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
getGeneralImage:function
- getGeneralImage(name: string, type: string, options?: any): AxiosPromise<any>
Parameters
name: string
type: string
Optional options: any
Returns AxiosPromise<any>
getGeneralImages:function
getMediaInfoImage:function
- getMediaInfoImage(theme: string, name: string, options?: any): AxiosPromise<any>
Parameters
theme: string
name: string
Optional options: any
Returns AxiosPromise<any>
getMediaInfoImages:function
getRatingImage:function
- getRatingImage(theme: string, name: string, options?: any): AxiosPromise<any>
Parameters
theme: string
name: string
Optional options: any
Returns AxiosPromise<any>
getRatingImages:function
Const ImageByNameApiFp
- ImageByNameApiFp(configuration?: Configuration): { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
Parameters
Returns { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
getGeneralImage:function
- getGeneralImage(name: string, type: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
type: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getGeneralImages:function
- getGeneralImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
getMediaInfoImage:function
- getMediaInfoImage(theme: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
theme: string
name: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getMediaInfoImages:function
- getMediaInfoImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
getRatingImage:function
- getRatingImage(theme: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
theme: string
name: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getRatingImages:function
- getRatingImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
Const InstantMixApiAxiosParamCreator
- InstantMixApiAxiosParamCreator(configuration?: Configuration): { getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs> }
getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
name: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
Const InstantMixApiFactory
- InstantMixApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
getInstantMixFromAlbum:function
- getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromArtists:function
- getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromArtists2:function
- getInstantMixFromArtists2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromItem:function
- getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromMusicGenreById:function
- getInstantMixFromMusicGenreById(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromMusicGenreById2:function
- getInstantMixFromMusicGenreById2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromMusicGenreByName:function
- getInstantMixFromMusicGenreByName(name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
name: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromPlaylist:function
- getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
getInstantMixFromSong:function
- getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Const InstantMixApiFp
- InstantMixApiFp(configuration?: Configuration): { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
Parameters
Returns { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
getInstantMixFromAlbum:function
- getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromArtists:function
- getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromArtists2:function
- getInstantMixFromArtists2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromItem:function
- getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromMusicGenreById:function
- getInstantMixFromMusicGenreById(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromMusicGenreById2:function
- getInstantMixFromMusicGenreById2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromMusicGenreByName:function
- getInstantMixFromMusicGenreByName(name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
name: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromPlaylist:function
- getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getInstantMixFromSong:function
- getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
id: string
Optional userId: string
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const ItemLookupApiAxiosParamCreator
- ItemLookupApiAxiosParamCreator(configuration?: Configuration): { applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>; getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs> }
Parameters
Returns { applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>; getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs> }
applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional replaceAllImages: boolean
options: any = {}
Returns Promise<RequestArgs>
getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const ItemLookupApiFactory
- ItemLookupApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
applySearchCriteria:function
- applySearchCriteria(itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional replaceAllImages: boolean
Optional options: any
Returns AxiosPromise<void>
getBookRemoteSearchResults:function
getBoxSetRemoteSearchResults:function
getExternalIdInfos:function
- getExternalIdInfos(itemId: string, options?: any): AxiosPromise<ExternalIdInfo[]>
Parameters
itemId: string
Optional options: any
getMovieRemoteSearchResults:function
getMusicAlbumRemoteSearchResults:function
getMusicArtistRemoteSearchResults:function
getMusicVideoRemoteSearchResults:function
getPersonRemoteSearchResults:function
getSeriesRemoteSearchResults:function
getTrailerRemoteSearchResults:function
Const ItemLookupApiFp
- ItemLookupApiFp(configuration?: Configuration): { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
Parameters
Returns { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
applySearchCriteria:function
- applySearchCriteria(itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional replaceAllImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getBookRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getBoxSetRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getExternalIdInfos:function
- getExternalIdInfos(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalIdInfo[]>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalIdInfo[]>>
getMovieRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getMusicAlbumRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getMusicArtistRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getMusicVideoRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getPersonRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getSeriesRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
getTrailerRemoteSearchResults:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
Const ItemRefreshApiAxiosParamCreator
- ItemRefreshApiAxiosParamCreator(configuration?: Configuration): { post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs> }
post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional replaceAllMetadata: boolean
Optional replaceAllImages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const ItemRefreshApiFactory
- ItemRefreshApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { post: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { post: any }
post:function
- post(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional replaceAllMetadata: boolean
Optional replaceAllImages: boolean
Optional options: any
Returns AxiosPromise<void>
Const ItemRefreshApiFp
Parameters
Returns { post: any }
post:function
- post(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional replaceAllMetadata: boolean
Optional replaceAllImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ItemUpdateApiAxiosParamCreator
- ItemUpdateApiAxiosParamCreator(configuration?: Configuration): { getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>; updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>; updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>; updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>; updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs> }
getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>
- (itemId: string, baseItemDto: BaseItemDto, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, contentType?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional contentType: string
options: any = {}
Returns Promise<RequestArgs>
Const ItemUpdateApiFactory
- ItemUpdateApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
getMetadataEditorInfo:function
Parameters
itemId: string
Optional options: any
updateItem:function
- updateItem(itemId: string, baseItemDto: BaseItemDto, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<void>
updateItemContentType:function
- updateItemContentType(itemId: string, contentType?: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional contentType: string
Optional options: any
Returns AxiosPromise<void>
Const ItemUpdateApiFp
- ItemUpdateApiFp(configuration?: Configuration): { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
Parameters
Returns { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
getMetadataEditorInfo:function
- getMetadataEditorInfo(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataEditorInfo>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataEditorInfo>>
updateItem:function
- updateItem(itemId: string, baseItemDto: BaseItemDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateItemContentType:function
- updateItemContentType(itemId: string, contentType?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional contentType: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const ItemsApiAxiosParamCreator
- ItemsApiAxiosParamCreator(configuration?: Configuration): { getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional mediaTypes: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const ItemsApiFactory
- ItemsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getItems: any; getItemsByUserId: any; getResumeItems: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getItems: any; getItemsByUserId: any; getResumeItems: any }
getItems:function
- getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
getItemsByUserId:function
- getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
getResumeItems:function
- getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
userId: string
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional mediaTypes: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Const ItemsApiFp
- ItemsApiFp(configuration?: Configuration): { getItems: any; getItemsByUserId: any; getResumeItems: any }
Parameters
Returns { getItems: any; getItemsByUserId: any; getResumeItems: any }
getItems:function
- getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getItemsByUserId:function
- getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getResumeItems:function
- getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
userId: string
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional mediaTypes: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const LibraryApiAxiosParamCreator
- LibraryApiAxiosParamCreator(configuration?: Configuration): { deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>; deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>; getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>; getDownload: (itemId: string, options?: any) => Promise<RequestArgs>; getFile: (itemId: string, options?: any) => Promise<RequestArgs>; getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>; getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>; getPhysicalPaths: (options?: any) => Promise<RequestArgs>; getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>; postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; refreshLibrary: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>; deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>; getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>; getDownload: (itemId: string, options?: any) => Promise<RequestArgs>; getFile: (itemId: string, options?: any) => Promise<RequestArgs>; getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>; getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>; getPhysicalPaths: (options?: any) => Promise<RequestArgs>; getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>; postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; refreshLibrary: (options?: any) => Promise<RequestArgs> }
deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>
- (ids?: string[], options?: any): Promise<RequestArgs>
Parameters
Optional ids: string[]
options: any = {}
Returns Promise<RequestArgs>
getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getDownload: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getFile: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, isFavorite?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional isFavorite: boolean
options: any = {}
Returns Promise<RequestArgs>
getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>
- (libraryContentType?: string, isNewLibrary?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional libraryContentType: string
Optional isNewLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>
- (isHidden?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional isHidden: boolean
options: any = {}
Returns Promise<RequestArgs>
getPhysicalPaths: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
- (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
options: any = {}
Returns Promise<RequestArgs>
getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
options: any = {}
Returns Promise<RequestArgs>
getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
options: any = {}
Returns Promise<RequestArgs>
getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
options: any = {}
Returns Promise<RequestArgs>
postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>
- (tmdbId?: string, imdbId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional tmdbId: string
Optional imdbId: string
options: any = {}
Returns Promise<RequestArgs>
postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>
- (tvdbId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional tvdbId: string
options: any = {}
Returns Promise<RequestArgs>
postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>
- (tmdbId?: string, imdbId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional tmdbId: string
Optional imdbId: string
options: any = {}
Returns Promise<RequestArgs>
postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>
- (tvdbId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional tvdbId: string
options: any = {}
Returns Promise<RequestArgs>
refreshLibrary: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const LibraryApiFactory
- LibraryApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
deleteItem:function
- deleteItem(itemId: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<void>
deleteItems:function
- deleteItems(ids?: string[], options?: any): AxiosPromise<void>
Parameters
Optional ids: string[]
Optional options: any
Returns AxiosPromise<void>
getAncestors:function
- getAncestors(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto[]>
Parameters
itemId: string
Optional userId: string
Optional options: any
Returns AxiosPromise<BaseItemDto[]>
getCriticReviews:function
Parameters
itemId: string
Optional options: any
getDownload:function
- getDownload(itemId: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<any>
getFile:function
- getFile(itemId: string, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<any>
getItemCounts:function
- getItemCounts(userId?: string, isFavorite?: boolean, options?: any): AxiosPromise<ItemCounts>
Parameters
Optional userId: string
Optional isFavorite: boolean
Optional options: any
Returns AxiosPromise<ItemCounts>
getLibraryOptionsInfo:function
- getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: any): AxiosPromise<LibraryOptionsResultDto>
Parameters
Optional libraryContentType: string
Optional isNewLibrary: boolean
Optional options: any
getMediaFolders:function
Parameters
Optional isHidden: boolean
Optional options: any
getPhysicalPaths:function
- getPhysicalPaths(options?: any): AxiosPromise<string[]>
Parameters
Returns AxiosPromise<string[]>
getSimilarAlbums:function
- getSimilarAlbums(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getSimilarArtists:function
- getSimilarArtists(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getSimilarItems:function
- getSimilarItems(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getSimilarMovies:function
- getSimilarMovies(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getSimilarShows:function
- getSimilarShows(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getSimilarTrailers:function
- getSimilarTrailers(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
getThemeMedia:function
- getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<AllThemeMediaResult>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
getThemeSongs:function
- getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<ThemeMediaResult>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
getThemeVideos:function
- getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<ThemeMediaResult>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
postAddedMovies:function
- postAddedMovies(tmdbId?: string, imdbId?: string, options?: any): AxiosPromise<void>
Parameters
Optional tmdbId: string
Optional imdbId: string
Optional options: any
Returns AxiosPromise<void>
postAddedSeries:function
- postAddedSeries(tvdbId?: string, options?: any): AxiosPromise<void>
Parameters
Optional tvdbId: string
Optional options: any
Returns AxiosPromise<void>
postUpdatedMedia:function
- postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
postUpdatedMovies:function
- postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: any): AxiosPromise<void>
Parameters
Optional tmdbId: string
Optional imdbId: string
Optional options: any
Returns AxiosPromise<void>
postUpdatedSeries:function
- postUpdatedSeries(tvdbId?: string, options?: any): AxiosPromise<void>
Parameters
Optional tvdbId: string
Optional options: any
Returns AxiosPromise<void>
refreshLibrary:function
- refreshLibrary(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const LibraryApiFp
- LibraryApiFp(configuration?: Configuration): { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
Parameters
Returns { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
deleteItem:function
- deleteItem(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteItems:function
- deleteItems(ids?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional ids: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getAncestors:function
- getAncestors(itemId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
Parameters
itemId: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
getCriticReviews:function
- getCriticReviews(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getDownload:function
- getDownload(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getFile:function
- getFile(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getItemCounts:function
- getItemCounts(userId?: string, isFavorite?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>
Parameters
Optional userId: string
Optional isFavorite: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>
getLibraryOptionsInfo:function
- getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>
Parameters
Optional libraryContentType: string
Optional isNewLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>
getMediaFolders:function
- getMediaFolders(isHidden?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional isHidden: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getPhysicalPaths:function
- getPhysicalPaths(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
getSimilarAlbums:function
- getSimilarAlbums(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSimilarArtists:function
- getSimilarArtists(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSimilarItems:function
- getSimilarItems(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSimilarMovies:function
- getSimilarMovies(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSimilarShows:function
- getSimilarShows(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSimilarTrailers:function
- getSimilarTrailers(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional excludeArtistIds: string[]
Optional userId: string
Optional limit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getThemeMedia:function
- getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>>
getThemeSongs:function
- getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
getThemeVideos:function
- getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
Parameters
itemId: string
Optional userId: string
Optional inheritFromParent: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
postAddedMovies:function
- postAddedMovies(tmdbId?: string, imdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional tmdbId: string
Optional imdbId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postAddedSeries:function
- postAddedSeries(tvdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional tvdbId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postUpdatedMedia:function
- postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postUpdatedMovies:function
- postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional tmdbId: string
Optional imdbId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postUpdatedSeries:function
- postUpdatedSeries(tvdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional tvdbId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
refreshLibrary:function
- refreshLibrary(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const LibraryStructureApiAxiosParamCreator
- LibraryStructureApiAxiosParamCreator(configuration?: Configuration): { addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>; getVirtualFolders: (options?: any) => Promise<RequestArgs>; removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>; updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>; getVirtualFolders: (options?: any) => Promise<RequestArgs>; removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>; updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs> }
addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
- (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional refreshLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>
Parameters
Optional name: string
Optional paths: string[]
Optional refreshLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
getVirtualFolders: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
- (name?: string, path?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
Optional path: string
Optional refreshLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
- (name?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
Optional refreshLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
- (name?: string, newName?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
Optional newName: string
Optional refreshLibrary: boolean
options: any = {}
Returns Promise<RequestArgs>
updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const LibraryStructureApiFactory
- LibraryStructureApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
addMediaPath:function
- addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
Parameters
Optional refreshLibrary: boolean
Optional options: any
Returns AxiosPromise<void>
addVirtualFolder:function
Parameters
Optional name: string
Optional paths: string[]
Optional refreshLibrary: boolean
Optional options: any
Returns AxiosPromise<void>
getVirtualFolders:function
removeMediaPath:function
- removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
Parameters
Optional name: string
Optional path: string
Optional refreshLibrary: boolean
Optional options: any
Returns AxiosPromise<void>
removeVirtualFolder:function
- removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
Parameters
Optional name: string
Optional refreshLibrary: boolean
Optional options: any
Returns AxiosPromise<void>
renameVirtualFolder:function
- renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
Parameters
Optional name: string
Optional newName: string
Optional refreshLibrary: boolean
Optional options: any
Returns AxiosPromise<void>
updateLibraryOptions:function
Parameters
Returns AxiosPromise<void>
updateMediaPath:function
Parameters
Returns AxiosPromise<void>
Const LibraryStructureApiFp
- LibraryStructureApiFp(configuration?: Configuration): { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
Parameters
Returns { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
addMediaPath:function
- addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional refreshLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
addVirtualFolder:function
- addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional name: string
Optional paths: string[]
Optional refreshLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getVirtualFolders:function
- getVirtualFolders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>>
removeMediaPath:function
- removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional name: string
Optional path: string
Optional refreshLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
removeVirtualFolder:function
- removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional name: string
Optional refreshLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
renameVirtualFolder:function
- renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional name: string
Optional newName: string
Optional refreshLibrary: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateLibraryOptions:function
- updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateMediaPath:function
- updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const LiveTvApiAxiosParamCreator
- LiveTvApiAxiosParamCreator(configuration?: Configuration): { addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>; addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>; cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>; createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>; deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>; deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>; deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>; discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>; getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>; getDefaultListingProvider: (options?: any) => Promise<RequestArgs>; getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>; getGuideInfo: (options?: any) => Promise<RequestArgs>; getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>; getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>; getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>; getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>; getLiveTvInfo: (options?: any) => Promise<RequestArgs>; getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>; getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>; getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>; getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>; getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>; getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>; getTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>; getTunerHostTypes: (options?: any) => Promise<RequestArgs>; resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>; setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>; updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>; addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>; cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>; createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>; deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>; deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>; deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>; discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>; getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>; getDefaultListingProvider: (options?: any) => Promise<RequestArgs>; getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>; getGuideInfo: (options?: any) => Promise<RequestArgs>; getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>; getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>; getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>; getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>; getLiveTvInfo: (options?: any) => Promise<RequestArgs>; getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>; getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>; getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>; getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>; getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>; getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>; getTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>; getTunerHostTypes: (options?: any) => Promise<RequestArgs>; resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>; setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>; updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs> }
addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>
- (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any): Promise<RequestArgs>
Parameters
Optional pw: string
Optional validateListings: boolean
Optional validateLogin: boolean
options: any = {}
Returns Promise<RequestArgs>
addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>
- (tunerHostInfo?: TunerHostInfo, options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>
- (timerId: string, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>
- (timerId: string, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>
- (timerInfoDto?: TimerInfoDto, options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>
- (id?: string, options?: any): Promise<RequestArgs>
Parameters
Optional id: string
options: any = {}
Returns Promise<RequestArgs>
deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>
- (recordingId: string, options?: any): Promise<RequestArgs>
Parameters
recordingId: string
options: any = {}
Returns Promise<RequestArgs>
deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>
- (id?: string, options?: any): Promise<RequestArgs>
Parameters
Optional id: string
options: any = {}
Returns Promise<RequestArgs>
discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>
- (newDevicesOnly?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional newDevicesOnly: boolean
options: any = {}
Returns Promise<RequestArgs>
discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>
- (newDevicesOnly?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional newDevicesOnly: boolean
options: any = {}
Returns Promise<RequestArgs>
getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>
- (channelId: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
channelId: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>
- (providerId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional providerId: string
options: any = {}
Returns Promise<RequestArgs>
getDefaultListingProvider: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>
- (programId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional programId: string
options: any = {}
Returns Promise<RequestArgs>
getGuideInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>
- (id?: string, type?: string, location?: string, country?: string, options?: any): Promise<RequestArgs>
Parameters
Optional id: string
Optional type: string
Optional location: string
Optional country: string
options: any = {}
Returns Promise<RequestArgs>
getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>
- (recordingId: string, options?: any): Promise<RequestArgs>
Parameters
recordingId: string
options: any = {}
Returns Promise<RequestArgs>
getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>
- (streamId: string, container: string, options?: any): Promise<RequestArgs>
Parameters
streamId: string
container: string
options: any = {}
Returns Promise<RequestArgs>
getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>
- (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional startIndex: number
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional limit: number
Optional isFavorite: boolean
Optional isLiked: boolean
Optional isDisliked: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string[]
Optional sortOrder: SortOrder
Optional enableFavoriteSorting: boolean
Optional addCurrentProgram: boolean
options: any = {}
Returns Promise<RequestArgs>
getLiveTvInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional channelIds: string[]
Optional userId: string
Optional minStartDate: string
Optional hasAired: boolean
Optional isAiring: boolean
Optional maxStartDate: string
Optional minEndDate: string
Optional maxEndDate: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional startIndex: number
Optional limit: number
Optional sortBy: string[]
Optional sortOrder: SortOrder[]
Optional genres: string[]
Optional genreIds: string[]
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional seriesTimerId: string
Optional librarySeriesId: string
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>
- (programId: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
programId: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>
- (getProgramsDto?: GetProgramsDto, options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional limit: number
Optional isAiring: boolean
Optional hasAired: boolean
Optional isSeries: boolean
Optional isMovie: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional genreIds: string[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>
- (recordingId: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
recordingId: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>
- (userId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>
- (groupId: string, options?: any): Promise<RequestArgs>
Parameters
groupId: string
options: any = {}
Returns Promise<RequestArgs>
getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>
- (userId?: string, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional channelId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional isMovie: boolean
Optional isSeries: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional isNews: boolean
Optional isLibraryItem: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional channelId: string
Optional userId: string
Optional groupId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>
- (timerId: string, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>
- (sortBy?: string, sortOrder?: SortOrder, options?: any): Promise<RequestArgs>
Parameters
Optional sortBy: string
Optional sortOrder: SortOrder
options: any = {}
Returns Promise<RequestArgs>
getTimer: (timerId: string, options?: any) => Promise<RequestArgs>
- (timerId: string, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>
- (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional channelId: string
Optional seriesTimerId: string
Optional isActive: boolean
Optional isScheduled: boolean
options: any = {}
Returns Promise<RequestArgs>
getTunerHostTypes: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>
- (tunerId: string, options?: any): Promise<RequestArgs>
Parameters
tunerId: string
options: any = {}
Returns Promise<RequestArgs>
setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>
- (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>
- (timerId: string, timerInfoDto?: TimerInfoDto, options?: any): Promise<RequestArgs>
Parameters
timerId: string
options: any = {}
Returns Promise<RequestArgs>
Const LiveTvApiFactory
- LiveTvApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
addListingProvider:function
Parameters
Optional pw: string
Optional validateListings: boolean
Optional validateLogin: boolean
Optional options: any
addTunerHost:function
cancelSeriesTimer:function
- cancelSeriesTimer(timerId: string, options?: any): AxiosPromise<void>
Parameters
timerId: string
Optional options: any
Returns AxiosPromise<void>
cancelTimer:function
- cancelTimer(timerId: string, options?: any): AxiosPromise<void>
Parameters
timerId: string
Optional options: any
Returns AxiosPromise<void>
createSeriesTimer:function
- createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
createTimer:function
- createTimer(timerInfoDto?: TimerInfoDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
deleteListingProvider:function
- deleteListingProvider(id?: string, options?: any): AxiosPromise<void>
Parameters
Optional id: string
Optional options: any
Returns AxiosPromise<void>
deleteRecording:function
- deleteRecording(recordingId: string, options?: any): AxiosPromise<void>
Parameters
recordingId: string
Optional options: any
Returns AxiosPromise<void>
deleteTunerHost:function
- deleteTunerHost(id?: string, options?: any): AxiosPromise<void>
Parameters
Optional id: string
Optional options: any
Returns AxiosPromise<void>
discoverTuners:function
- discoverTuners(newDevicesOnly?: boolean, options?: any): AxiosPromise<TunerHostInfo[]>
Parameters
Optional newDevicesOnly: boolean
Optional options: any
discvoverTuners:function
- discvoverTuners(newDevicesOnly?: boolean, options?: any): AxiosPromise<TunerHostInfo[]>
Parameters
Optional newDevicesOnly: boolean
Optional options: any
getChannel:function
- getChannel(channelId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
channelId: string
Optional userId: string
Optional options: any
getChannelMappingOptions:function
Parameters
Optional providerId: string
Optional options: any
getDefaultListingProvider:function
getDefaultTimer:function
Parameters
Optional programId: string
Optional options: any
getGuideInfo:function
- getGuideInfo(options?: any): AxiosPromise<GuideInfo>
getLineups:function
- getLineups(id?: string, type?: string, location?: string, country?: string, options?: any): AxiosPromise<NameIdPair[]>
Parameters
Optional id: string
Optional type: string
Optional location: string
Optional country: string
Optional options: any
Returns AxiosPromise<NameIdPair[]>
getLiveRecordingFile:function
- getLiveRecordingFile(recordingId: string, options?: any): AxiosPromise<any>
Parameters
recordingId: string
Optional options: any
Returns AxiosPromise<any>
getLiveStreamFile:function
- getLiveStreamFile(streamId: string, container: string, options?: any): AxiosPromise<any>
Parameters
streamId: string
container: string
Optional options: any
Returns AxiosPromise<any>
getLiveTvChannels:function
- getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional startIndex: number
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional limit: number
Optional isFavorite: boolean
Optional isLiked: boolean
Optional isDisliked: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string[]
Optional sortOrder: SortOrder
Optional enableFavoriteSorting: boolean
Optional addCurrentProgram: boolean
Optional options: any
getLiveTvInfo:function
- getLiveTvInfo(options?: any): AxiosPromise<LiveTvInfo>
getLiveTvPrograms:function
- getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional channelIds: string[]
Optional userId: string
Optional minStartDate: string
Optional hasAired: boolean
Optional isAiring: boolean
Optional maxStartDate: string
Optional minEndDate: string
Optional maxEndDate: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional startIndex: number
Optional limit: number
Optional sortBy: string[]
Optional sortOrder: SortOrder[]
Optional genres: string[]
Optional genreIds: string[]
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional seriesTimerId: string
Optional librarySeriesId: string
Optional enableTotalRecordCount: boolean
Optional options: any
getProgram:function
- getProgram(programId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
programId: string
Optional userId: string
Optional options: any
getPrograms:function
getRecommendedPrograms:function
- getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional limit: number
Optional isAiring: boolean
Optional hasAired: boolean
Optional isSeries: boolean
Optional isMovie: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional genreIds: string[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
getRecording:function
- getRecording(recordingId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
recordingId: string
Optional userId: string
Optional options: any
getRecordingFolders:function
Parameters
Optional userId: string
Optional options: any
getRecordingGroup:function
- getRecordingGroup(groupId: string, options?: any): AxiosPromise<void>
Parameters
groupId: string
Optional options: any
Returns AxiosPromise<void>
getRecordingGroups:function
Parameters
Optional userId: string
Optional options: any
getRecordings:function
- getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional channelId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional isMovie: boolean
Optional isSeries: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional isNews: boolean
Optional isLibraryItem: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
getRecordingsSeries:function
- getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional channelId: string
Optional userId: string
Optional groupId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
getSchedulesDirectCountries:function
- getSchedulesDirectCountries(options?: any): AxiosPromise<any>
Parameters
Returns AxiosPromise<any>
getSeriesTimer:function
Parameters
timerId: string
Optional options: any
getSeriesTimers:function
Parameters
Optional sortBy: string
Optional sortOrder: SortOrder
Optional options: any
getTimer:function
- getTimer(timerId: string, options?: any): AxiosPromise<TimerInfoDto>
Parameters
timerId: string
Optional options: any
getTimers:function
- getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): AxiosPromise<TimerInfoDtoQueryResult>
Parameters
Optional channelId: string
Optional seriesTimerId: string
Optional isActive: boolean
Optional isScheduled: boolean
Optional options: any
getTunerHostTypes:function
- getTunerHostTypes(options?: any): AxiosPromise<NameIdPair[]>
resetTuner:function
- resetTuner(tunerId: string, options?: any): AxiosPromise<void>
Parameters
tunerId: string
Optional options: any
Returns AxiosPromise<void>
setChannelMapping:function
updateSeriesTimer:function
- updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): AxiosPromise<void>
Parameters
timerId: string
Optional options: any
Returns AxiosPromise<void>
updateTimer:function
- updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: any): AxiosPromise<void>
Parameters
timerId: string
Optional options: any
Returns AxiosPromise<void>
Const LiveTvApiFp
- LiveTvApiFp(configuration?: Configuration): { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
Parameters
Returns { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
addListingProvider:function
- addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
Parameters
Optional pw: string
Optional validateListings: boolean
Optional validateLogin: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
addTunerHost:function
- addTunerHost(tunerHostInfo?: TunerHostInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>>
cancelSeriesTimer:function
- cancelSeriesTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
cancelTimer:function
- cancelTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
createSeriesTimer:function
- createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
createTimer:function
- createTimer(timerInfoDto?: TimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteListingProvider:function
- deleteListingProvider(id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteRecording:function
- deleteRecording(recordingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
recordingId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
deleteTunerHost:function
- deleteTunerHost(id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
discoverTuners:function
- discoverTuners(newDevicesOnly?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
Parameters
Optional newDevicesOnly: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
discvoverTuners:function
- discvoverTuners(newDevicesOnly?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
Parameters
Optional newDevicesOnly: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
getChannel:function
- getChannel(channelId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
channelId: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getChannelMappingOptions:function
- getChannelMappingOptions(providerId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>>
Parameters
Optional providerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>>
getDefaultListingProvider:function
- getDefaultListingProvider(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
getDefaultTimer:function
- getDefaultTimer(programId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
Parameters
Optional programId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
getGuideInfo:function
- getGuideInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>>
getLineups:function
- getLineups(id?: string, type?: string, location?: string, country?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
Parameters
Optional id: string
Optional type: string
Optional location: string
Optional country: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
getLiveRecordingFile:function
- getLiveRecordingFile(recordingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
recordingId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getLiveStreamFile:function
- getLiveStreamFile(streamId: string, container: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
streamId: string
container: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getLiveTvChannels:function
- getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional startIndex: number
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional limit: number
Optional isFavorite: boolean
Optional isLiked: boolean
Optional isDisliked: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string[]
Optional sortOrder: SortOrder
Optional enableFavoriteSorting: boolean
Optional addCurrentProgram: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getLiveTvInfo:function
- getLiveTvInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>>
getLiveTvPrograms:function
- getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional channelIds: string[]
Optional userId: string
Optional minStartDate: string
Optional hasAired: boolean
Optional isAiring: boolean
Optional maxStartDate: string
Optional minEndDate: string
Optional maxEndDate: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional startIndex: number
Optional limit: number
Optional sortBy: string[]
Optional sortOrder: SortOrder[]
Optional genres: string[]
Optional genreIds: string[]
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional seriesTimerId: string
Optional librarySeriesId: string
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getProgram:function
- getProgram(programId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
programId: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getPrograms:function
getRecommendedPrograms:function
- getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional limit: number
Optional isAiring: boolean
Optional hasAired: boolean
Optional isSeries: boolean
Optional isMovie: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional genreIds: string[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getRecording:function
- getRecording(recordingId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
recordingId: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getRecordingFolders:function
- getRecordingFolders(userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getRecordingGroup:function
- getRecordingGroup(groupId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
groupId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getRecordingGroups:function
- getRecordingGroups(userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getRecordings:function
- getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional channelId: string
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional isMovie: boolean
Optional isSeries: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional isNews: boolean
Optional isLibraryItem: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getRecordingsSeries:function
- getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional channelId: string
Optional userId: string
Optional groupId: string
Optional startIndex: number
Optional limit: number
Optional isInProgress: boolean
Optional seriesTimerId: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSchedulesDirectCountries:function
- getSchedulesDirectCountries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getSeriesTimer:function
- getSeriesTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
getSeriesTimers:function
getTimer:function
- getTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>>
getTimers:function
- getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>>
Parameters
Optional channelId: string
Optional seriesTimerId: string
Optional isActive: boolean
Optional isScheduled: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>>
getTunerHostTypes:function
- getTunerHostTypes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
resetTuner:function
- resetTuner(tunerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
tunerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
setChannelMapping:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>>
updateSeriesTimer:function
- updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateTimer:function
- updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
timerId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const LocalizationApiAxiosParamCreator
- LocalizationApiAxiosParamCreator(configuration?: Configuration): { getCountries: (options?: any) => Promise<RequestArgs>; getCultures: (options?: any) => Promise<RequestArgs>; getLocalizationOptions: (options?: any) => Promise<RequestArgs>; getParentalRatings: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { getCountries: (options?: any) => Promise<RequestArgs>; getCultures: (options?: any) => Promise<RequestArgs>; getLocalizationOptions: (options?: any) => Promise<RequestArgs>; getParentalRatings: (options?: any) => Promise<RequestArgs> }
getCountries: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getCultures: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getLocalizationOptions: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getParentalRatings: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const LocalizationApiFactory
- LocalizationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
getCountries:function
- getCountries(options?: any): AxiosPromise<CountryInfo[]>
getCultures:function
- getCultures(options?: any): AxiosPromise<CultureDto[]>
getLocalizationOptions:function
getParentalRatings:function
Const LocalizationApiFp
- LocalizationApiFp(configuration?: Configuration): { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
Parameters
Returns { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
getCountries:function
- getCountries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryInfo[]>>
getCultures:function
- getCultures(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CultureDto[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CultureDto[]>>
getLocalizationOptions:function
- getLocalizationOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LocalizationOption[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LocalizationOption[]>>
getParentalRatings:function
- getParentalRatings(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParentalRating[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParentalRating[]>>
Const MediaInfoApiAxiosParamCreator
- MediaInfoApiAxiosParamCreator(configuration?: Configuration): { closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>; getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>; getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>; getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>; openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>; getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>; getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>; getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>; openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs> }
closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>
- (liveStreamId: string, options?: any): Promise<RequestArgs>
Parameters
liveStreamId: string
options: any = {}
Returns Promise<RequestArgs>
getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>
- (size?: number, options?: any): Promise<RequestArgs>
Parameters
Optional size: number
options: any = {}
Returns Promise<RequestArgs>
getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, userId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
userId: string
options: any = {}
Returns Promise<RequestArgs>
getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional mediaSourceId: string
Optional liveStreamId: string
Optional autoOpenLiveStream: boolean
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
Optional enableTranscoding: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
options: any = {}
Returns Promise<RequestArgs>
openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs>
- (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): Promise<RequestArgs>
Parameters
Optional openToken: string
Optional userId: string
Optional playSessionId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional itemId: string
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
options: any = {}
Returns Promise<RequestArgs>
Const MediaInfoApiFactory
- MediaInfoApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
closeLiveStream:function
- closeLiveStream(liveStreamId: string, options?: any): AxiosPromise<void>
Parameters
liveStreamId: string
Optional options: any
Returns AxiosPromise<void>
getBitrateTestBytes:function
- getBitrateTestBytes(size?: number, options?: any): AxiosPromise<any>
Parameters
Optional size: number
Optional options: any
Returns AxiosPromise<any>
getPlaybackInfo:function
Parameters
itemId: string
userId: string
Optional options: any
getPostedPlaybackInfo:function
- getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): AxiosPromise<PlaybackInfoResponse>
Parameters
itemId: string
Optional userId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional mediaSourceId: string
Optional liveStreamId: string
Optional autoOpenLiveStream: boolean
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
Optional enableTranscoding: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional options: any
openLiveStream:function
- openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): AxiosPromise<LiveStreamResponse>
Parameters
Optional openToken: string
Optional userId: string
Optional playSessionId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional itemId: string
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
Optional options: any
Const MediaInfoApiFp
- MediaInfoApiFp(configuration?: Configuration): { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
Parameters
Returns { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
closeLiveStream:function
- closeLiveStream(liveStreamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
liveStreamId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getBitrateTestBytes:function
- getBitrateTestBytes(size?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
Optional size: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getPlaybackInfo:function
- getPlaybackInfo(itemId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
Parameters
itemId: string
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
getPostedPlaybackInfo:function
- getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
Parameters
itemId: string
Optional userId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional mediaSourceId: string
Optional liveStreamId: string
Optional autoOpenLiveStream: boolean
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
Optional enableTranscoding: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
openLiveStream:function
- openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>
Parameters
Optional openToken: string
Optional userId: string
Optional playSessionId: string
Optional maxStreamingBitrate: number
Optional startTimeTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional maxAudioChannels: number
Optional itemId: string
Optional enableDirectPlay: boolean
Optional enableDirectStream: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>
Const MoviesApiAxiosParamCreator
- MoviesApiAxiosParamCreator(configuration?: Configuration): { getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs> }
getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs>
- (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional parentId: string
Optional categoryLimit: number
Optional itemLimit: number
options: any = {}
Returns Promise<RequestArgs>
Const MoviesApiFactory
- MoviesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMovieRecommendations: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getMovieRecommendations: any }
getMovieRecommendations:function
- getMovieRecommendations(userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): AxiosPromise<RecommendationDto[]>
Parameters
Optional userId: string
Optional parentId: string
Optional categoryLimit: number
Optional itemLimit: number
Optional options: any
Const MoviesApiFp
- MoviesApiFp(configuration?: Configuration): { getMovieRecommendations: any }
Parameters
Returns { getMovieRecommendations: any }
getMovieRecommendations:function
- getMovieRecommendations(userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecommendationDto[]>>
Parameters
Optional userId: string
Optional parentId: string
Optional categoryLimit: number
Optional itemLimit: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecommendationDto[]>>
Const MusicGenresApiAxiosParamCreator
- MusicGenresApiAxiosParamCreator(configuration?: Configuration): { getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>
- (genreName: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
genreName: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
Const MusicGenresApiFactory
- MusicGenresApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMusicGenre: any; getMusicGenres: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getMusicGenre: any; getMusicGenres: any }
getMusicGenre:function
- getMusicGenre(genreName: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
genreName: string
Optional userId: string
Optional options: any
getMusicGenres:function
- getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Const MusicGenresApiFp
- MusicGenresApiFp(configuration?: Configuration): { getMusicGenre: any; getMusicGenres: any }
Parameters
Returns { getMusicGenre: any; getMusicGenres: any }
getMusicGenre:function
- getMusicGenre(genreName: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
genreName: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getMusicGenres:function
- getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const NotificationsApiAxiosParamCreator
- NotificationsApiAxiosParamCreator(configuration?: Configuration): { createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>; getNotificationServices: (options?: any) => Promise<RequestArgs>; getNotificationTypes: (options?: any) => Promise<RequestArgs>; getNotifications: (userId: string, options?: any) => Promise<RequestArgs>; getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>; setRead: (userId: string, options?: any) => Promise<RequestArgs>; setUnread: (userId: string, options?: any) => Promise<RequestArgs> }
Parameters
Returns { createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>; getNotificationServices: (options?: any) => Promise<RequestArgs>; getNotificationTypes: (options?: any) => Promise<RequestArgs>; getNotifications: (userId: string, options?: any) => Promise<RequestArgs>; getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>; setRead: (userId: string, options?: any) => Promise<RequestArgs>; setUnread: (userId: string, options?: any) => Promise<RequestArgs> }
createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getNotificationServices: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getNotificationTypes: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getNotifications: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
setRead: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
setUnread: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
Const NotificationsApiFactory
- NotificationsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
createAdminNotification:function
- createAdminNotification(adminNotificationDto: AdminNotificationDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
getNotificationServices:function
- getNotificationServices(options?: any): AxiosPromise<NameIdPair[]>
getNotificationTypes:function
getNotifications:function
Parameters
userId: string
Optional options: any
getNotificationsSummary:function
Parameters
userId: string
Optional options: any
setRead:function
- setRead(userId: string, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
setUnread:function
- setUnread(userId: string, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
Const NotificationsApiFp
- NotificationsApiFp(configuration?: Configuration): { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
Parameters
Returns { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
createAdminNotification:function
- createAdminNotification(adminNotificationDto: AdminNotificationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getNotificationServices:function
- getNotificationServices(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
getNotificationTypes:function
- getNotificationTypes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTypeInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTypeInfo[]>>
getNotifications:function
- getNotifications(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationResultDto>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationResultDto>>
getNotificationsSummary:function
- getNotificationsSummary(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationsSummaryDto>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationsSummaryDto>>
setRead:function
- setRead(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
setUnread:function
- setUnread(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const PackageApiAxiosParamCreator
- PackageApiAxiosParamCreator(configuration?: Configuration): { cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>; getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>; getPackages: (options?: any) => Promise<RequestArgs>; getRepositories: (options?: any) => Promise<RequestArgs>; installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>; setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>; getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>; getPackages: (options?: any) => Promise<RequestArgs>; getRepositories: (options?: any) => Promise<RequestArgs>; installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>; setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs> }
cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>
- (packageId: string, options?: any): Promise<RequestArgs>
Parameters
packageId: string
options: any = {}
Returns Promise<RequestArgs>
getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>
- (name: string, assemblyGuid?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional assemblyGuid: string
options: any = {}
Returns Promise<RequestArgs>
getPackages: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getRepositories: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>
- (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional assemblyGuid: string
Optional version: string
Optional repositoryUrl: string
options: any = {}
Returns Promise<RequestArgs>
setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs>
- (repositoryInfo: RepositoryInfo[], options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const PackageApiFactory
- PackageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
cancelPackageInstallation:function
- cancelPackageInstallation(packageId: string, options?: any): AxiosPromise<void>
Parameters
packageId: string
Optional options: any
Returns AxiosPromise<void>
getPackageInfo:function
- getPackageInfo(name: string, assemblyGuid?: string, options?: any): AxiosPromise<PackageInfo>
Parameters
name: string
Optional assemblyGuid: string
Optional options: any
getPackages:function
- getPackages(options?: any): AxiosPromise<PackageInfo[]>
getRepositories:function
installPackage:function
- installPackage(name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): AxiosPromise<void>
Parameters
name: string
Optional assemblyGuid: string
Optional version: string
Optional repositoryUrl: string
Optional options: any
Returns AxiosPromise<void>
setRepositories:function
- setRepositories(repositoryInfo: RepositoryInfo[], options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const PackageApiFp
- PackageApiFp(configuration?: Configuration): { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
Parameters
Returns { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
cancelPackageInstallation:function
- cancelPackageInstallation(packageId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
packageId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPackageInfo:function
- getPackageInfo(name: string, assemblyGuid?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>>
Parameters
name: string
Optional assemblyGuid: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>>
getPackages:function
- getPackages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo[]>>
getRepositories:function
- getRepositories(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepositoryInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepositoryInfo[]>>
installPackage:function
- installPackage(name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
name: string
Optional assemblyGuid: string
Optional version: string
Optional repositoryUrl: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
setRepositories:function
- setRepositories(repositoryInfo: RepositoryInfo[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const PersonsApiAxiosParamCreator
- PersonsApiAxiosParamCreator(configuration?: Configuration): { getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
- (name: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional limit: number
Optional searchTerm: string
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludePersonTypes: string[]
Optional personTypes: string[]
Optional appearsInItemId: string
Optional userId: string
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const PersonsApiFactory
- PersonsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getPerson: any; getPersons: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getPerson: any; getPersons: any }
getPerson:function
- getPerson(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
name: string
Optional userId: string
Optional options: any
getPersons:function
- getPersons(limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional limit: number
Optional searchTerm: string
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludePersonTypes: string[]
Optional personTypes: string[]
Optional appearsInItemId: string
Optional userId: string
Optional enableImages: boolean
Optional options: any
Const PersonsApiFp
- PersonsApiFp(configuration?: Configuration): { getPerson: any; getPersons: any }
Parameters
Returns { getPerson: any; getPersons: any }
getPerson:function
- getPerson(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
name: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getPersons:function
- getPersons(limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional limit: number
Optional searchTerm: string
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional excludePersonTypes: string[]
Optional personTypes: string[]
Optional appearsInItemId: string
Optional userId: string
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const PlaylistsApiAxiosParamCreator
- PlaylistsApiAxiosParamCreator(configuration?: Configuration): { addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>; createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>; getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>; removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>; createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>; getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>; removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs> }
addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>
- (playlistId: string, ids?: string[], userId?: string, options?: any): Promise<RequestArgs>
Parameters
playlistId: string
Optional ids: string[]
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>
- (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): Promise<RequestArgs>
Parameters
Optional name: string
Optional ids: string[]
Optional userId: string
Optional mediaType: string
options: any = {}
Returns Promise<RequestArgs>
getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
- (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
Parameters
playlistId: string
userId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
options: any = {}
Returns Promise<RequestArgs>
moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>
- (playlistId: string, itemId: string, newIndex: number, options?: any): Promise<RequestArgs>
Parameters
playlistId: string
itemId: string
newIndex: number
options: any = {}
Returns Promise<RequestArgs>
removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs>
- (playlistId: string, entryIds?: string[], options?: any): Promise<RequestArgs>
Parameters
playlistId: string
Optional entryIds: string[]
options: any = {}
Returns Promise<RequestArgs>
Const PlaylistsApiFactory
- PlaylistsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
addToPlaylist:function
- addToPlaylist(playlistId: string, ids?: string[], userId?: string, options?: any): AxiosPromise<void>
Parameters
playlistId: string
Optional ids: string[]
Optional userId: string
Optional options: any
Returns AxiosPromise<void>
createPlaylist:function
Parameters
Optional name: string
Optional ids: string[]
Optional userId: string
Optional mediaType: string
Optional options: any
getPlaylistItems:function
- getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
playlistId: string
userId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
moveItem:function
- moveItem(playlistId: string, itemId: string, newIndex: number, options?: any): AxiosPromise<void>
Parameters
playlistId: string
itemId: string
newIndex: number
Optional options: any
Returns AxiosPromise<void>
removeFromPlaylist:function
- removeFromPlaylist(playlistId: string, entryIds?: string[], options?: any): AxiosPromise<void>
Parameters
playlistId: string
Optional entryIds: string[]
Optional options: any
Returns AxiosPromise<void>
Const PlaylistsApiFp
- PlaylistsApiFp(configuration?: Configuration): { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
Parameters
Returns { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
addToPlaylist:function
- addToPlaylist(playlistId: string, ids?: string[], userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
playlistId: string
Optional ids: string[]
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
createPlaylist:function
- createPlaylist(name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>>
Parameters
Optional name: string
Optional ids: string[]
Optional userId: string
Optional mediaType: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>>
getPlaylistItems:function
- getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
playlistId: string
userId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
moveItem:function
- moveItem(playlistId: string, itemId: string, newIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
playlistId: string
itemId: string
newIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
removeFromPlaylist:function
- removeFromPlaylist(playlistId: string, entryIds?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
playlistId: string
Optional entryIds: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const PlaystateApiAxiosParamCreator
- PlaystateApiAxiosParamCreator(configuration?: Configuration): { markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>; markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>; pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>; reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs> }
Parameters
Returns { markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>; markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>; pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>; reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs> }
markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, datePlayed?: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
Optional datePlayed: string
options: any = {}
Returns Promise<RequestArgs>
markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional positionTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional volumeLevel: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional repeatMode: RepeatMode
Optional isPaused: boolean
Optional isMuted: boolean
options: any = {}
Returns Promise<RequestArgs>
onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional canSeek: boolean
options: any = {}
Returns Promise<RequestArgs>
onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional nextMediaType: string
Optional positionTicks: number
Optional liveStreamId: string
Optional playSessionId: string
options: any = {}
Returns Promise<RequestArgs>
pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>
- (playSessionId: string, options?: any): Promise<RequestArgs>
Parameters
playSessionId: string
options: any = {}
Returns Promise<RequestArgs>
reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const PlaystateApiFactory
- PlaystateApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
markPlayedItem:function
- markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional datePlayed: string
Optional options: any
markUnplayedItem:function
- markUnplayedItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional options: any
onPlaybackProgress:function
- onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise<void>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional positionTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional volumeLevel: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional repeatMode: RepeatMode
Optional isPaused: boolean
Optional isMuted: boolean
Optional options: any
Returns AxiosPromise<void>
onPlaybackStart:function
- onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise<void>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional canSeek: boolean
Optional options: any
Returns AxiosPromise<void>
onPlaybackStopped:function
- onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise<void>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional nextMediaType: string
Optional positionTicks: number
Optional liveStreamId: string
Optional playSessionId: string
Optional options: any
Returns AxiosPromise<void>
pingPlaybackSession:function
- pingPlaybackSession(playSessionId: string, options?: any): AxiosPromise<void>
Parameters
playSessionId: string
Optional options: any
Returns AxiosPromise<void>
reportPlaybackProgress:function
- reportPlaybackProgress(playbackProgressInfo?: PlaybackProgressInfo, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
reportPlaybackStart:function
- reportPlaybackStart(playbackStartInfo?: PlaybackStartInfo, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
reportPlaybackStopped:function
- reportPlaybackStopped(playbackStopInfo?: PlaybackStopInfo, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const PlaystateApiFp
- PlaystateApiFp(configuration?: Configuration): { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
Parameters
Returns { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
markPlayedItem:function
- markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional datePlayed: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
markUnplayedItem:function
- markUnplayedItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
onPlaybackProgress:function
- onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional positionTicks: number
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional volumeLevel: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional repeatMode: RepeatMode
Optional isPaused: boolean
Optional isMuted: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
onPlaybackStart:function
- onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional playMethod: PlayMethod
Optional liveStreamId: string
Optional playSessionId: string
Optional canSeek: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
onPlaybackStopped:function
- onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
itemId: string
Optional mediaSourceId: string
Optional nextMediaType: string
Optional positionTicks: number
Optional liveStreamId: string
Optional playSessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
pingPlaybackSession:function
- pingPlaybackSession(playSessionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
playSessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
reportPlaybackProgress:function
- reportPlaybackProgress(playbackProgressInfo?: PlaybackProgressInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
reportPlaybackStart:function
- reportPlaybackStart(playbackStartInfo?: PlaybackStartInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
reportPlaybackStopped:function
- reportPlaybackStopped(playbackStopInfo?: PlaybackStopInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const PluginsApiAxiosParamCreator
- PluginsApiAxiosParamCreator(configuration?: Configuration): { disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>; getPlugins: (options?: any) => Promise<RequestArgs>; uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>; uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs> }
Parameters
Returns { disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>; getPlugins: (options?: any) => Promise<RequestArgs>; uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>; uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs> }
disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
- (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
- (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>
- (pluginId: string, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
- (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>
- (pluginId: string, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
getPlugins: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>
- (pluginId: string, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
- (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>
- (pluginId: string, options?: any): Promise<RequestArgs>
Parameters
pluginId: string
options: any = {}
Returns Promise<RequestArgs>
updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const PluginsApiFactory
- PluginsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
disablePlugin:function
- disablePlugin(pluginId: string, version: Version, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
enablePlugin:function
- enablePlugin(pluginId: string, version: Version, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
getPluginConfiguration:function
- getPluginConfiguration(pluginId: string, options?: any): AxiosPromise<object>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<object>
getPluginImage:function
- getPluginImage(pluginId: string, version: Version, options?: any): AxiosPromise<any>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<any>
getPluginManifest:function
- getPluginManifest(pluginId: string, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
getPlugins:function
- getPlugins(options?: any): AxiosPromise<PluginInfo[]>
uninstallPlugin:function
- uninstallPlugin(pluginId: string, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
uninstallPluginByVersion:function
- uninstallPluginByVersion(pluginId: string, version: Version, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
updatePluginConfiguration:function
- updatePluginConfiguration(pluginId: string, options?: any): AxiosPromise<void>
Parameters
pluginId: string
Optional options: any
Returns AxiosPromise<void>
updatePluginSecurityInfo:function
- updatePluginSecurityInfo(pluginSecurityInfo: PluginSecurityInfo, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const PluginsApiFp
- PluginsApiFp(configuration?: Configuration): { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
Parameters
Returns { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
disablePlugin:function
- disablePlugin(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
enablePlugin:function
- enablePlugin(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPluginConfiguration:function
- getPluginConfiguration(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
getPluginImage:function
- getPluginImage(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getPluginManifest:function
- getPluginManifest(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getPlugins:function
- getPlugins(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>>
uninstallPlugin:function
- uninstallPlugin(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
uninstallPluginByVersion:function
- uninstallPluginByVersion(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updatePluginConfiguration:function
- updatePluginConfiguration(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
pluginId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updatePluginSecurityInfo:function
- updatePluginSecurityInfo(pluginSecurityInfo: PluginSecurityInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const QuickConnectApiAxiosParamCreator
- QuickConnectApiAxiosParamCreator(configuration?: Configuration): { activate: (options?: any) => Promise<RequestArgs>; authorize: (code: string, options?: any) => Promise<RequestArgs>; available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>; connect: (secret: string, options?: any) => Promise<RequestArgs>; deauthorize: (options?: any) => Promise<RequestArgs>; getStatus: (options?: any) => Promise<RequestArgs>; initiate: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { activate: (options?: any) => Promise<RequestArgs>; authorize: (code: string, options?: any) => Promise<RequestArgs>; available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>; connect: (secret: string, options?: any) => Promise<RequestArgs>; deauthorize: (options?: any) => Promise<RequestArgs>; getStatus: (options?: any) => Promise<RequestArgs>; initiate: (options?: any) => Promise<RequestArgs> }
activate: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
authorize: (code: string, options?: any) => Promise<RequestArgs>
- (code: string, options?: any): Promise<RequestArgs>
Parameters
code: string
options: any = {}
Returns Promise<RequestArgs>
available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
connect: (secret: string, options?: any) => Promise<RequestArgs>
- (secret: string, options?: any): Promise<RequestArgs>
Parameters
secret: string
options: any = {}
Returns Promise<RequestArgs>
deauthorize: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getStatus: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
initiate: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const QuickConnectApiFactory
- QuickConnectApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
activate:function
- activate(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
authorize:function
- authorize(code: string, options?: any): AxiosPromise<boolean>
Parameters
code: string
Optional options: any
Returns AxiosPromise<boolean>
available:function
Parameters
Returns AxiosPromise<void>
connect:function
Parameters
secret: string
Optional options: any
deauthorize:function
- deauthorize(options?: any): AxiosPromise<number>
Parameters
Returns AxiosPromise<number>
getStatus:function
initiate:function
Const QuickConnectApiFp
- QuickConnectApiFp(configuration?: Configuration): { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
Parameters
Returns { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
activate:function
- activate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
authorize:function
- authorize(code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>
Parameters
code: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>
available:function
- available(status?: QuickConnectState, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
connect:function
- connect(secret: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
Parameters
secret: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
deauthorize:function
- deauthorize(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>
getStatus:function
- getStatus(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectState>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectState>>
initiate:function
- initiate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
Const RemoteImageApiAxiosParamCreator
- RemoteImageApiAxiosParamCreator(configuration?: Configuration): { downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>; getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>; getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>; getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>; getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs> }
downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, type: ImageType, imageUrl?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional imageUrl: string
options: any = {}
Returns Promise<RequestArgs>
getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional startIndex: number
Optional limit: number
Optional providerName: string
Optional includeAllLanguages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const RemoteImageApiFactory
- RemoteImageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
downloadRemoteImage:function
- downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional imageUrl: string
Optional options: any
Returns AxiosPromise<void>
getRemoteImageProviders:function
- getRemoteImageProviders(itemId: string, options?: any): AxiosPromise<ImageProviderInfo[]>
Parameters
itemId: string
Optional options: any
getRemoteImages:function
- getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): AxiosPromise<RemoteImageResult>
Parameters
itemId: string
Optional startIndex: number
Optional limit: number
Optional providerName: string
Optional includeAllLanguages: boolean
Optional options: any
Const RemoteImageApiFp
- RemoteImageApiFp(configuration?: Configuration): { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
Parameters
Returns { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
downloadRemoteImage:function
- downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional imageUrl: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getRemoteImageProviders:function
- getRemoteImageProviders(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageProviderInfo[]>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageProviderInfo[]>>
getRemoteImages:function
- getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>
Parameters
itemId: string
Optional startIndex: number
Optional limit: number
Optional providerName: string
Optional includeAllLanguages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>
Const ScheduledTasksApiAxiosParamCreator
- ScheduledTasksApiAxiosParamCreator(configuration?: Configuration): { getTask: (taskId: string, options?: any) => Promise<RequestArgs>; getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>; startTask: (taskId: string, options?: any) => Promise<RequestArgs>; stopTask: (taskId: string, options?: any) => Promise<RequestArgs>; updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { getTask: (taskId: string, options?: any) => Promise<RequestArgs>; getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>; startTask: (taskId: string, options?: any) => Promise<RequestArgs>; stopTask: (taskId: string, options?: any) => Promise<RequestArgs>; updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs> }
getTask: (taskId: string, options?: any) => Promise<RequestArgs>
- (taskId: string, options?: any): Promise<RequestArgs>
Parameters
taskId: string
options: any = {}
Returns Promise<RequestArgs>
getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>
- (isHidden?: boolean, isEnabled?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional isHidden: boolean
Optional isEnabled: boolean
options: any = {}
Returns Promise<RequestArgs>
startTask: (taskId: string, options?: any) => Promise<RequestArgs>
- (taskId: string, options?: any): Promise<RequestArgs>
Parameters
taskId: string
options: any = {}
Returns Promise<RequestArgs>
stopTask: (taskId: string, options?: any) => Promise<RequestArgs>
- (taskId: string, options?: any): Promise<RequestArgs>
Parameters
taskId: string
options: any = {}
Returns Promise<RequestArgs>
updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs>
- (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): Promise<RequestArgs>
Parameters
taskId: string
options: any = {}
Returns Promise<RequestArgs>
Const ScheduledTasksApiFactory
- ScheduledTasksApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
getTask:function
- getTask(taskId: string, options?: any): AxiosPromise<TaskInfo>
Parameters
taskId: string
Optional options: any
Returns AxiosPromise<TaskInfo>
getTasks:function
- getTasks(isHidden?: boolean, isEnabled?: boolean, options?: any): AxiosPromise<TaskInfo[]>
Parameters
Optional isHidden: boolean
Optional isEnabled: boolean
Optional options: any
Returns AxiosPromise<TaskInfo[]>
startTask:function
- startTask(taskId: string, options?: any): AxiosPromise<void>
Parameters
taskId: string
Optional options: any
Returns AxiosPromise<void>
stopTask:function
- stopTask(taskId: string, options?: any): AxiosPromise<void>
Parameters
taskId: string
Optional options: any
Returns AxiosPromise<void>
updateTask:function
- updateTask(taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): AxiosPromise<void>
Parameters
taskId: string
Optional options: any
Returns AxiosPromise<void>
Const ScheduledTasksApiFp
- ScheduledTasksApiFp(configuration?: Configuration): { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
Parameters
Returns { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
getTask:function
- getTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo>>
Parameters
taskId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo>>
getTasks:function
- getTasks(isHidden?: boolean, isEnabled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>>
Parameters
Optional isHidden: boolean
Optional isEnabled: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>>
startTask:function
- startTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
taskId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
stopTask:function
- stopTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
taskId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateTask:function
- updateTask(taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
taskId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const SearchApiAxiosParamCreator
- SearchApiAxiosParamCreator(configuration?: Configuration): { get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs> }
get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs>
- (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): Promise<RequestArgs>
Parameters
searchTerm: string
Optional startIndex: number
Optional limit: number
Optional userId: string
Optional includeItemTypes: string[]
Optional excludeItemTypes: string[]
Optional mediaTypes: string[]
Optional parentId: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional includePeople: boolean
Optional includeMedia: boolean
Optional includeGenres: boolean
Optional includeStudios: boolean
Optional includeArtists: boolean
options: any = {}
Returns Promise<RequestArgs>
Const SearchApiFactory
- SearchApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { get: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { get: any }
get:function
- get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): AxiosPromise<SearchHintResult>
Parameters
searchTerm: string
Optional startIndex: number
Optional limit: number
Optional userId: string
Optional includeItemTypes: string[]
Optional excludeItemTypes: string[]
Optional mediaTypes: string[]
Optional parentId: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional includePeople: boolean
Optional includeMedia: boolean
Optional includeGenres: boolean
Optional includeStudios: boolean
Optional includeArtists: boolean
Optional options: any
Const SearchApiFp
Parameters
Returns { get: any }
get:function
- get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>
Parameters
searchTerm: string
Optional startIndex: number
Optional limit: number
Optional userId: string
Optional includeItemTypes: string[]
Optional excludeItemTypes: string[]
Optional mediaTypes: string[]
Optional parentId: string
Optional isMovie: boolean
Optional isSeries: boolean
Optional isNews: boolean
Optional isKids: boolean
Optional isSports: boolean
Optional includePeople: boolean
Optional includeMedia: boolean
Optional includeGenres: boolean
Optional includeStudios: boolean
Optional includeArtists: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>
Const SessionApiAxiosParamCreator
- SessionApiAxiosParamCreator(configuration?: Configuration): { addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>; getAuthProviders: (options?: any) => Promise<RequestArgs>; getPasswordResetProviders: (options?: any) => Promise<RequestArgs>; getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>; play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>; postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>; postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>; removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; reportSessionEnded: (options?: any) => Promise<RequestArgs>; reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>; sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>; sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>; sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>; sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>; sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs> }
Parameters
Returns { addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>; getAuthProviders: (options?: any) => Promise<RequestArgs>; getPasswordResetProviders: (options?: any) => Promise<RequestArgs>; getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>; play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>; postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>; postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>; removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; reportSessionEnded: (options?: any) => Promise<RequestArgs>; reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>; sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>; sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>; sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>; sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>; sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs> }
addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>
- (sessionId: string, userId: string, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
userId: string
options: any = {}
Returns Promise<RequestArgs>
displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>
- (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
itemType: string
itemId: string
itemName: string
options: any = {}
Returns Promise<RequestArgs>
getAuthProviders: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getPasswordResetProviders: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>
- (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): Promise<RequestArgs>
Parameters
Optional controllableByUserId: string
Optional deviceId: string
Optional activeWithinSeconds: number
options: any = {}
Returns Promise<RequestArgs>
play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>
- (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
itemIds: string[]
Optional startPositionTicks: number
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional startIndex: number
options: any = {}
Returns Promise<RequestArgs>
postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>
- (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional id: string
Optional playableMediaTypes: string[]
Optional supportsMediaControl: boolean
Optional supportsSync: boolean
Optional supportsPersistentIdentifier: boolean
options: any = {}
Returns Promise<RequestArgs>
postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>
Parameters
Optional id: string
options: any = {}
Returns Promise<RequestArgs>
removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>
- (sessionId: string, userId: string, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
userId: string
options: any = {}
Returns Promise<RequestArgs>
reportSessionEnded: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, sessionId?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional sessionId: string
options: any = {}
Returns Promise<RequestArgs>
sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>
- (sessionId: string, generalCommand: GeneralCommand, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
options: any = {}
Returns Promise<RequestArgs>
sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>
Parameters
sessionId: string
options: any = {}
Returns Promise<RequestArgs>
sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>
- (sessionId: string, messageCommand: MessageCommand, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
options: any = {}
Returns Promise<RequestArgs>
sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>
- (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): Promise<RequestArgs>
Parameters
sessionId: string
Optional seekPositionTicks: number
Optional controllingUserId: string
options: any = {}
Returns Promise<RequestArgs>
sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>
Parameters
sessionId: string
options: any = {}
Returns Promise<RequestArgs>
Const SessionApiFactory
- SessionApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
addUserToSession:function
- addUserToSession(sessionId: string, userId: string, options?: any): AxiosPromise<void>
Parameters
sessionId: string
userId: string
Optional options: any
Returns AxiosPromise<void>
displayContent:function
- displayContent(sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): AxiosPromise<void>
Parameters
sessionId: string
itemType: string
itemId: string
itemName: string
Optional options: any
Returns AxiosPromise<void>
getAuthProviders:function
- getAuthProviders(options?: any): AxiosPromise<NameIdPair[]>
getPasswordResetProviders:function
- getPasswordResetProviders(options?: any): AxiosPromise<NameIdPair[]>
getSessions:function
- getSessions(controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): AxiosPromise<SessionInfo[]>
Parameters
Optional controllableByUserId: string
Optional deviceId: string
Optional activeWithinSeconds: number
Optional options: any
Returns AxiosPromise<SessionInfo[]>
play:function
- play(sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): AxiosPromise<void>
Parameters
sessionId: string
itemIds: string[]
Optional startPositionTicks: number
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional startIndex: number
Optional options: any
Returns AxiosPromise<void>
postCapabilities:function
- postCapabilities(id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise<void>
Parameters
Optional id: string
Optional playableMediaTypes: string[]
Optional supportsMediaControl: boolean
Optional supportsSync: boolean
Optional supportsPersistentIdentifier: boolean
Optional options: any
Returns AxiosPromise<void>
postFullCapabilities:function
- postFullCapabilities(clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any): AxiosPromise<void>
Parameters
Optional id: string
Optional options: any
Returns AxiosPromise<void>
removeUserFromSession:function
- removeUserFromSession(sessionId: string, userId: string, options?: any): AxiosPromise<void>
Parameters
sessionId: string
userId: string
Optional options: any
Returns AxiosPromise<void>
reportSessionEnded:function
- reportSessionEnded(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
reportViewing:function
- reportViewing(itemId: string, sessionId?: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional sessionId: string
Optional options: any
Returns AxiosPromise<void>
sendFullGeneralCommand:function
- sendFullGeneralCommand(sessionId: string, generalCommand: GeneralCommand, options?: any): AxiosPromise<void>
Parameters
sessionId: string
Optional options: any
Returns AxiosPromise<void>
sendGeneralCommand:function
- sendGeneralCommand(sessionId: string, command: GeneralCommandType, options?: any): AxiosPromise<void>
Parameters
sessionId: string
Optional options: any
Returns AxiosPromise<void>
sendMessageCommand:function
- sendMessageCommand(sessionId: string, messageCommand: MessageCommand, options?: any): AxiosPromise<void>
Parameters
sessionId: string
Optional options: any
Returns AxiosPromise<void>
sendPlaystateCommand:function
- sendPlaystateCommand(sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): AxiosPromise<void>
Parameters
sessionId: string
Optional seekPositionTicks: number
Optional controllingUserId: string
Optional options: any
Returns AxiosPromise<void>
sendSystemCommand:function
- sendSystemCommand(sessionId: string, command: GeneralCommandType, options?: any): AxiosPromise<void>
Parameters
sessionId: string
Optional options: any
Returns AxiosPromise<void>
Const SessionApiFp
- SessionApiFp(configuration?: Configuration): { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
Parameters
Returns { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
addUserToSession:function
- addUserToSession(sessionId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
displayContent:function
- displayContent(sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
itemType: string
itemId: string
itemName: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getAuthProviders:function
- getAuthProviders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
getPasswordResetProviders:function
- getPasswordResetProviders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
getSessions:function
- getSessions(controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionInfo[]>>
Parameters
Optional controllableByUserId: string
Optional deviceId: string
Optional activeWithinSeconds: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionInfo[]>>
play:function
- play(sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
itemIds: string[]
Optional startPositionTicks: number
Optional mediaSourceId: string
Optional audioStreamIndex: number
Optional subtitleStreamIndex: number
Optional startIndex: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postCapabilities:function
- postCapabilities(id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional id: string
Optional playableMediaTypes: string[]
Optional supportsMediaControl: boolean
Optional supportsSync: boolean
Optional supportsPersistentIdentifier: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
postFullCapabilities:function
- postFullCapabilities(clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Optional id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
removeUserFromSession:function
- removeUserFromSession(sessionId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
reportSessionEnded:function
- reportSessionEnded(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
reportViewing:function
- reportViewing(itemId: string, sessionId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional sessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
sendFullGeneralCommand:function
- sendFullGeneralCommand(sessionId: string, generalCommand: GeneralCommand, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
sendGeneralCommand:function
- sendGeneralCommand(sessionId: string, command: GeneralCommandType, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
sendMessageCommand:function
- sendMessageCommand(sessionId: string, messageCommand: MessageCommand, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
sendPlaystateCommand:function
- sendPlaystateCommand(sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
Optional seekPositionTicks: number
Optional controllingUserId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
sendSystemCommand:function
- sendSystemCommand(sessionId: string, command: GeneralCommandType, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
sessionId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const StartupApiAxiosParamCreator
- StartupApiAxiosParamCreator(configuration?: Configuration): { completeWizard: (options?: any) => Promise<RequestArgs>; getFirstUser: (options?: any) => Promise<RequestArgs>; getFirstUser2: (options?: any) => Promise<RequestArgs>; getStartupConfiguration: (options?: any) => Promise<RequestArgs>; setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>; updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>; updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { completeWizard: (options?: any) => Promise<RequestArgs>; getFirstUser: (options?: any) => Promise<RequestArgs>; getFirstUser2: (options?: any) => Promise<RequestArgs>; getStartupConfiguration: (options?: any) => Promise<RequestArgs>; setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>; updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>; updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs> }
completeWizard: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getFirstUser: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getFirstUser2: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getStartupConfiguration: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs>
- (startupUserDto?: StartupUserDto, options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const StartupApiFactory
- StartupApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
completeWizard:function
- completeWizard(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
getFirstUser:function
getFirstUser2:function
getStartupConfiguration:function
setRemoteAccess:function
Parameters
Returns AxiosPromise<void>
updateInitialConfiguration:function
Parameters
Returns AxiosPromise<void>
updateStartupUser:function
- updateStartupUser(startupUserDto?: StartupUserDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const StartupApiFp
- StartupApiFp(configuration?: Configuration): { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
Parameters
Returns { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
completeWizard:function
- completeWizard(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getFirstUser:function
- getFirstUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
getFirstUser2:function
- getFirstUser2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
getStartupConfiguration:function
- getStartupConfiguration(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>>
setRemoteAccess:function
- setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateInitialConfiguration:function
- updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateStartupUser:function
- updateStartupUser(startupUserDto?: StartupUserDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const StudiosApiAxiosParamCreator
- StudiosApiAxiosParamCreator(configuration?: Configuration): { getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
- (name: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
name: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
Const StudiosApiFactory
- StudiosApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getStudio: any; getStudios: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getStudio: any; getStudios: any }
getStudio:function
- getStudio(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
name: string
Optional userId: string
Optional options: any
getStudios:function
- getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Const StudiosApiFp
- StudiosApiFp(configuration?: Configuration): { getStudio: any; getStudios: any }
Parameters
Returns { getStudio: any; getStudios: any }
getStudio:function
- getStudio(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
name: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getStudios:function
- getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional startIndex: number
Optional limit: number
Optional searchTerm: string
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional isFavorite: boolean
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional enableImages: boolean
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const SubtitleApiAxiosParamCreator
- SubtitleApiAxiosParamCreator(configuration?: Configuration): { deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>; downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>; getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>; getFallbackFontList: (options?: any) => Promise<RequestArgs>; getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>; getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>; getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>; getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>; searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>; uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>; downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>; getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>; getFallbackFontList: (options?: any) => Promise<RequestArgs>; getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>; getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>; getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>; getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>; searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>; uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs> }
deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>
- (itemId: string, index: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
index: number
options: any = {}
Returns Promise<RequestArgs>
downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, subtitleId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
subtitleId: string
options: any = {}
Returns Promise<RequestArgs>
getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>
- (name: string, options?: any): Promise<RequestArgs>
Parameters
name: string
options: any = {}
Returns Promise<RequestArgs>
getFallbackFontList: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>
- (id: string, options?: any): Promise<RequestArgs>
Parameters
id: string
options: any = {}
Returns Promise<RequestArgs>
getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>
- (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): Promise<RequestArgs>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
Optional startPositionTicks: number
options: any = {}
Returns Promise<RequestArgs>
getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>
- (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): Promise<RequestArgs>
Parameters
itemId: string
index: number
mediaSourceId: string
segmentLength: number
options: any = {}
Returns Promise<RequestArgs>
getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>
- (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): Promise<RequestArgs>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeStartPositionTicks: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional startPositionTicks: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
options: any = {}
Returns Promise<RequestArgs>
searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, language: string, isPerfectMatch?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
language: string
Optional isPerfectMatch: boolean
options: any = {}
Returns Promise<RequestArgs>
uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs>
- (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
Const SubtitleApiFactory
- SubtitleApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
deleteSubtitle:function
- deleteSubtitle(itemId: string, index: number, options?: any): AxiosPromise<void>
Parameters
itemId: string
index: number
Optional options: any
Returns AxiosPromise<void>
downloadRemoteSubtitles:function
- downloadRemoteSubtitles(itemId: string, subtitleId: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
subtitleId: string
Optional options: any
Returns AxiosPromise<void>
getFallbackFont:function
- getFallbackFont(name: string, options?: any): AxiosPromise<any>
Parameters
name: string
Optional options: any
Returns AxiosPromise<any>
getFallbackFontList:function
- getFallbackFontList(options?: any): AxiosPromise<FontFile[]>
Parameters
Returns AxiosPromise<FontFile[]>
getRemoteSubtitles:function
- getRemoteSubtitles(id: string, options?: any): AxiosPromise<any>
Parameters
id: string
Optional options: any
Returns AxiosPromise<any>
getSubtitle:function
- getSubtitle(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): AxiosPromise<any>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
Optional startPositionTicks: number
Optional options: any
Returns AxiosPromise<any>
getSubtitlePlaylist:function
- getSubtitlePlaylist(itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): AxiosPromise<any>
Parameters
itemId: string
index: number
mediaSourceId: string
segmentLength: number
Optional options: any
Returns AxiosPromise<any>
getSubtitleWithTicks:function
- getSubtitleWithTicks(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): AxiosPromise<any>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeStartPositionTicks: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional startPositionTicks: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
Optional options: any
Returns AxiosPromise<any>
searchRemoteSubtitles:function
- searchRemoteSubtitles(itemId: string, language: string, isPerfectMatch?: boolean, options?: any): AxiosPromise<RemoteSubtitleInfo[]>
Parameters
itemId: string
language: string
Optional isPerfectMatch: boolean
Optional options: any
uploadSubtitle:function
- uploadSubtitle(itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<void>
Const SubtitleApiFp
- SubtitleApiFp(configuration?: Configuration): { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
Parameters
Returns { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
deleteSubtitle:function
- deleteSubtitle(itemId: string, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
index: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
downloadRemoteSubtitles:function
- downloadRemoteSubtitles(itemId: string, subtitleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
subtitleId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getFallbackFont:function
- getFallbackFont(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getFallbackFontList:function
- getFallbackFontList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FontFile[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FontFile[]>>
getRemoteSubtitles:function
- getRemoteSubtitles(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
id: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getSubtitle:function
- getSubtitle(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
Optional startPositionTicks: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getSubtitlePlaylist:function
- getSubtitlePlaylist(itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
index: number
mediaSourceId: string
segmentLength: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getSubtitleWithTicks:function
- getSubtitleWithTicks(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
routeItemId: string
routeMediaSourceId: string
routeIndex: number
routeStartPositionTicks: number
routeFormat: string
Optional itemId: string
Optional mediaSourceId: string
Optional index: number
Optional startPositionTicks: number
Optional format: string
Optional endPositionTicks: number
Optional copyTimestamps: boolean
Optional addVttTimeMap: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
searchRemoteSubtitles:function
- searchRemoteSubtitles(itemId: string, language: string, isPerfectMatch?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSubtitleInfo[]>>
Parameters
itemId: string
language: string
Optional isPerfectMatch: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSubtitleInfo[]>>
uploadSubtitle:function
- uploadSubtitle(itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const SuggestionsApiAxiosParamCreator
- SuggestionsApiAxiosParamCreator(configuration?: Configuration): { getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional mediaType: string[]
Optional type: string[]
Optional startIndex: number
Optional limit: number
Optional enableTotalRecordCount: boolean
options: any = {}
Returns Promise<RequestArgs>
Const SuggestionsApiFactory
- SuggestionsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getSuggestions: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getSuggestions: any }
getSuggestions:function
- getSuggestions(userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
userId: string
Optional mediaType: string[]
Optional type: string[]
Optional startIndex: number
Optional limit: number
Optional enableTotalRecordCount: boolean
Optional options: any
Const SuggestionsApiFp
- SuggestionsApiFp(configuration?: Configuration): { getSuggestions: any }
Parameters
Returns { getSuggestions: any }
getSuggestions:function
- getSuggestions(userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
userId: string
Optional mediaType: string[]
Optional type: string[]
Optional startIndex: number
Optional limit: number
Optional enableTotalRecordCount: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const SyncPlayApiAxiosParamCreator
- SyncPlayApiAxiosParamCreator(configuration?: Configuration): { syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>; syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayGetGroups: (options?: any) => Promise<RequestArgs>; syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>; syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPause: (options?: any) => Promise<RequestArgs>; syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>; syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>; syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlayStop: (options?: any) => Promise<RequestArgs>; syncPlayUnpause: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>; syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayGetGroups: (options?: any) => Promise<RequestArgs>; syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>; syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPause: (options?: any) => Promise<RequestArgs>; syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>; syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>; syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlayStop: (options?: any) => Promise<RequestArgs>; syncPlayUnpause: (options?: any) => Promise<RequestArgs> }
syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayGetGroups: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayPause: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayStop: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
syncPlayUnpause: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const SyncPlayApiFactory
- SyncPlayApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
syncPlayBuffering:function
- syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayCreateGroup:function
- syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayGetGroups:function
- syncPlayGetGroups(options?: any): AxiosPromise<GroupInfoDto[]>
syncPlayJoinGroup:function
Parameters
Returns AxiosPromise<void>
syncPlayLeaveGroup:function
- syncPlayLeaveGroup(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayMovePlaylistItem:function
Parameters
Returns AxiosPromise<void>
syncPlayNextItem:function
- syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayPause:function
- syncPlayPause(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayPing:function
- syncPlayPing(pingRequestDto: PingRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayPreviousItem:function
Parameters
Returns AxiosPromise<void>
syncPlayQueue:function
- syncPlayQueue(queueRequestDto: QueueRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayReady:function
- syncPlayReady(readyRequestDto: ReadyRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayRemoveFromPlaylist:function
Parameters
Returns AxiosPromise<void>
syncPlaySeek:function
- syncPlaySeek(seekRequestDto: SeekRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlaySetIgnoreWait:function
- syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlaySetNewQueue:function
- syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlaySetPlaylistItem:function
Parameters
Returns AxiosPromise<void>
syncPlaySetRepeatMode:function
Parameters
Returns AxiosPromise<void>
syncPlaySetShuffleMode:function
Parameters
Returns AxiosPromise<void>
syncPlayStop:function
- syncPlayStop(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
syncPlayUnpause:function
- syncPlayUnpause(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const SyncPlayApiFp
- SyncPlayApiFp(configuration?: Configuration): { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
Parameters
Returns { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
syncPlayBuffering:function
- syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayCreateGroup:function
- syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayGetGroups:function
- syncPlayGetGroups(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>>
syncPlayJoinGroup:function
- syncPlayJoinGroup(joinGroupRequestDto: JoinGroupRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayLeaveGroup:function
- syncPlayLeaveGroup(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayMovePlaylistItem:function
- syncPlayMovePlaylistItem(movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayNextItem:function
- syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayPause:function
- syncPlayPause(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayPing:function
- syncPlayPing(pingRequestDto: PingRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayPreviousItem:function
- syncPlayPreviousItem(previousItemRequestDto: PreviousItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayQueue:function
- syncPlayQueue(queueRequestDto: QueueRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayReady:function
- syncPlayReady(readyRequestDto: ReadyRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayRemoveFromPlaylist:function
- syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySeek:function
- syncPlaySeek(seekRequestDto: SeekRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySetIgnoreWait:function
- syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySetNewQueue:function
- syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySetPlaylistItem:function
- syncPlaySetPlaylistItem(setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySetRepeatMode:function
- syncPlaySetRepeatMode(setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlaySetShuffleMode:function
- syncPlaySetShuffleMode(setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayStop:function
- syncPlayStop(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
syncPlayUnpause:function
- syncPlayUnpause(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const SystemApiAxiosParamCreator
- SystemApiAxiosParamCreator(configuration?: Configuration): { getEndpointInfo: (options?: any) => Promise<RequestArgs>; getLogFile: (name: string, options?: any) => Promise<RequestArgs>; getPingSystem: (options?: any) => Promise<RequestArgs>; getPublicSystemInfo: (options?: any) => Promise<RequestArgs>; getServerLogs: (options?: any) => Promise<RequestArgs>; getSystemInfo: (options?: any) => Promise<RequestArgs>; getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>; postPingSystem: (options?: any) => Promise<RequestArgs>; restartApplication: (options?: any) => Promise<RequestArgs>; shutdownApplication: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { getEndpointInfo: (options?: any) => Promise<RequestArgs>; getLogFile: (name: string, options?: any) => Promise<RequestArgs>; getPingSystem: (options?: any) => Promise<RequestArgs>; getPublicSystemInfo: (options?: any) => Promise<RequestArgs>; getServerLogs: (options?: any) => Promise<RequestArgs>; getSystemInfo: (options?: any) => Promise<RequestArgs>; getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>; postPingSystem: (options?: any) => Promise<RequestArgs>; restartApplication: (options?: any) => Promise<RequestArgs>; shutdownApplication: (options?: any) => Promise<RequestArgs> }
getEndpointInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getLogFile: (name: string, options?: any) => Promise<RequestArgs>
- (name: string, options?: any): Promise<RequestArgs>
Parameters
name: string
options: any = {}
Returns Promise<RequestArgs>
getPingSystem: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getPublicSystemInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getServerLogs: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getSystemInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
postPingSystem: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
restartApplication: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
shutdownApplication: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const SystemApiFactory
- SystemApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
getEndpointInfo:function
getLogFile:function
- getLogFile(name: string, options?: any): AxiosPromise<any>
Parameters
name: string
Optional options: any
Returns AxiosPromise<any>
getPingSystem:function
- getPingSystem(options?: any): AxiosPromise<string>
Parameters
Returns AxiosPromise<string>
getPublicSystemInfo:function
getServerLogs:function
- getServerLogs(options?: any): AxiosPromise<LogFile[]>
Parameters
Returns AxiosPromise<LogFile[]>
getSystemInfo:function
- getSystemInfo(options?: any): AxiosPromise<SystemInfo>
getWakeOnLanInfo:function
postPingSystem:function
- postPingSystem(options?: any): AxiosPromise<string>
Parameters
Returns AxiosPromise<string>
restartApplication:function
- restartApplication(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
shutdownApplication:function
- shutdownApplication(options?: any): AxiosPromise<void>
Parameters
Returns AxiosPromise<void>
Const SystemApiFp
- SystemApiFp(configuration?: Configuration): { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
Parameters
Returns { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
getEndpointInfo:function
- getEndpointInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>
getLogFile:function
- getLogFile(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
name: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getPingSystem:function
- getPingSystem(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
getPublicSystemInfo:function
- getPublicSystemInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>
getServerLogs:function
- getServerLogs(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>>
getSystemInfo:function
- getSystemInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>
getWakeOnLanInfo:function
- getWakeOnLanInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>>
postPingSystem:function
- postPingSystem(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
restartApplication:function
- restartApplication(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
shutdownApplication:function
- shutdownApplication(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const TimeSyncApiAxiosParamCreator
- TimeSyncApiAxiosParamCreator(configuration?: Configuration): { getUtcTime: (options?: any) => Promise<RequestArgs> }
Parameters
Returns { getUtcTime: (options?: any) => Promise<RequestArgs> }
getUtcTime: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
Const TimeSyncApiFactory
- TimeSyncApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getUtcTime: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getUtcTime: any }
Const TimeSyncApiFp
- TimeSyncApiFp(configuration?: Configuration): { getUtcTime: any }
Parameters
Returns { getUtcTime: any }
getUtcTime:function
- getUtcTime(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UtcTimeResponse>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UtcTimeResponse>>
Const TrailersApiAxiosParamCreator
- TrailersApiAxiosParamCreator(configuration?: Configuration): { getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const TrailersApiFactory
- TrailersApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getTrailers: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getTrailers: any }
getTrailers:function
- getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Const TrailersApiFp
- TrailersApiFp(configuration?: Configuration): { getTrailers: any }
Parameters
Returns { getTrailers: any }
getTrailers:function
- getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional maxOfficialRating: string
Optional hasThemeSong: boolean
Optional hasThemeVideo: boolean
Optional hasSubtitles: boolean
Optional hasSpecialFeature: boolean
Optional hasTrailer: boolean
Optional adjacentTo: string
Optional parentIndexNumber: number
Optional hasParentalRating: boolean
Optional isHd: boolean
Optional is4K: boolean
Optional locationTypes: LocationType[]
Optional excludeLocationTypes: LocationType[]
Optional isMissing: boolean
Optional isUnaired: boolean
Optional minCommunityRating: number
Optional minCriticRating: number
Optional minPremiereDate: string
Optional minDateLastSaved: string
Optional minDateLastSavedForUser: string
Optional maxPremiereDate: string
Optional hasOverview: boolean
Optional hasImdbId: boolean
Optional hasTmdbId: boolean
Optional hasTvdbId: boolean
Optional excludeItemIds: string[]
Optional startIndex: number
Optional limit: number
Optional recursive: boolean
Optional searchTerm: string
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional isFavorite: boolean
Optional mediaTypes: string[]
Optional imageTypes: ImageType[]
Optional sortBy: string[]
Optional isPlayed: boolean
Optional genres: string[]
Optional officialRatings: string[]
Optional tags: string[]
Optional years: number[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional person: string
Optional personIds: string[]
Optional personTypes: string[]
Optional studios: string[]
Optional artists: string[]
Optional excludeArtistIds: string[]
Optional artistIds: string[]
Optional albumArtistIds: string[]
Optional contributingArtistIds: string[]
Optional albums: string[]
Optional albumIds: string[]
Optional ids: string[]
Optional videoTypes: VideoType[]
Optional minOfficialRating: string
Optional isLocked: boolean
Optional isPlaceHolder: boolean
Optional hasOfficialRating: boolean
Optional collapseBoxSetItems: boolean
Optional minWidth: number
Optional minHeight: number
Optional maxWidth: number
Optional maxHeight: number
Optional is3D: boolean
Optional seriesStatus: SeriesStatus[]
Optional nameStartsWithOrGreater: string
Optional nameStartsWith: string
Optional nameLessThan: string
Optional studioIds: string[]
Optional genreIds: string[]
Optional enableTotalRecordCount: boolean
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const TvShowsApiAxiosParamCreator
- TvShowsApiAxiosParamCreator(configuration?: Configuration): { getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>; getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>; getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>; getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>; getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>; getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>; getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs> }
getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>
- (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): Promise<RequestArgs>
Parameters
seriesId: string
Optional userId: string
Optional season: number
Optional seasonId: string
Optional isMissing: boolean
Optional adjacentTo: string
Optional startItemId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string
options: any = {}
Returns Promise<RequestArgs>
getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional seriesId: string
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional disableFirstEpisode: boolean
options: any = {}
Returns Promise<RequestArgs>
getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>
- (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<RequestArgs>
Parameters
seriesId: string
Optional userId: string
Optional isSpecialSeason: boolean
Optional isMissing: boolean
Optional adjacentTo: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
options: any = {}
Returns Promise<RequestArgs>
getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>
- (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
options: any = {}
Returns Promise<RequestArgs>
Const TvShowsApiFactory
- TvShowsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
getEpisodes:function
- getEpisodes(seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
seriesId: string
Optional userId: string
Optional season: number
Optional seasonId: string
Optional isMissing: boolean
Optional adjacentTo: string
Optional startItemId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string
Optional options: any
getNextUp:function
- getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional seriesId: string
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional disableFirstEpisode: boolean
Optional options: any
getSeasons:function
- getSeasons(seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
seriesId: string
Optional userId: string
Optional isSpecialSeason: boolean
Optional isMissing: boolean
Optional adjacentTo: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional options: any
getUpcomingEpisodes:function
- getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional options: any
Const TvShowsApiFp
- TvShowsApiFp(configuration?: Configuration): { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
Parameters
Returns { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
getEpisodes:function
- getEpisodes(seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
seriesId: string
Optional userId: string
Optional season: number
Optional seasonId: string
Optional isMissing: boolean
Optional adjacentTo: string
Optional startItemId: string
Optional startIndex: number
Optional limit: number
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional sortBy: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getNextUp:function
- getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional seriesId: string
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional enableTotalRecordCount: boolean
Optional disableFirstEpisode: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getSeasons:function
- getSeasons(seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
seriesId: string
Optional userId: string
Optional isSpecialSeason: boolean
Optional isMissing: boolean
Optional adjacentTo: string
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getUpcomingEpisodes:function
- getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional userId: string
Optional startIndex: number
Optional limit: number
Optional parentId: string
Optional enableImges: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const UniversalAudioApiAxiosParamCreator
- UniversalAudioApiAxiosParamCreator(configuration?: Configuration): { getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>; headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>; headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs> }
getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
options: any = {}
Returns Promise<RequestArgs>
headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
options: any = {}
Returns Promise<RequestArgs>
Const UniversalAudioApiFactory
- UniversalAudioApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getUniversalAudioStream: any; headUniversalAudioStream: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getUniversalAudioStream: any; headUniversalAudioStream: any }
getUniversalAudioStream:function
- getUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
Optional options: any
Returns AxiosPromise<any>
headUniversalAudioStream:function
- headUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
Optional options: any
Returns AxiosPromise<any>
Const UniversalAudioApiFp
- UniversalAudioApiFp(configuration?: Configuration): { getUniversalAudioStream: any; headUniversalAudioStream: any }
Parameters
Returns { getUniversalAudioStream: any; headUniversalAudioStream: any }
getUniversalAudioStream:function
- getUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headUniversalAudioStream:function
- headUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string[]
Optional mediaSourceId: string
Optional deviceId: string
Optional userId: string
Optional audioCodec: string
Optional maxAudioChannels: number
Optional transcodingAudioChannels: number
Optional maxStreamingBitrate: number
Optional audioBitRate: number
Optional startTimeTicks: number
Optional transcodingContainer: string
Optional transcodingProtocol: string
Optional maxAudioSampleRate: number
Optional maxAudioBitDepth: number
Optional enableRemoteMedia: boolean
Optional breakOnNonKeyFrames: boolean
Optional enableRedirection: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const UserApiAxiosParamCreator
- UserApiAxiosParamCreator(configuration?: Configuration): { authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>; authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>; authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>; createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>; deleteUser: (userId: string, options?: any) => Promise<RequestArgs>; forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>; forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>; getCurrentUser: (options?: any) => Promise<RequestArgs>; getPublicUsers: (options?: any) => Promise<RequestArgs>; getUserById: (userId: string, options?: any) => Promise<RequestArgs>; getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>; updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>; updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>; updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>; updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>; updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs> }
Parameters
Returns { authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>; authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>; authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>; createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>; deleteUser: (userId: string, options?: any) => Promise<RequestArgs>; forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>; forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>; getCurrentUser: (options?: any) => Promise<RequestArgs>; getPublicUsers: (options?: any) => Promise<RequestArgs>; getUserById: (userId: string, options?: any) => Promise<RequestArgs>; getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>; updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>; updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>; updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>; updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>; updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs> }
authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>
- (userId: string, pw: string, password?: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
pw: string
Optional password: string
options: any = {}
Returns Promise<RequestArgs>
authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
deleteUser: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getCurrentUser: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getPublicUsers: (options?: any) => Promise<RequestArgs>
- (options?: any): Promise<RequestArgs>
Parameters
Returns Promise<RequestArgs>
getUserById: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>
- (isHidden?: boolean, isDisabled?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional isHidden: boolean
Optional isDisabled: boolean
options: any = {}
Returns Promise<RequestArgs>
updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>
- (userId: string, userDto: UserDto, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>
- (userId: string, userConfiguration: UserConfiguration, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>
- (userId: string, updateUserPassword: UpdateUserPassword, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs>
- (userId: string, userPolicy: UserPolicy, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
Const UserApiFactory
- UserApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
authenticateUser:function
- authenticateUser(userId: string, pw: string, password?: string, options?: any): AxiosPromise<AuthenticationResult>
Parameters
userId: string
pw: string
Optional password: string
Optional options: any
authenticateUserByName:function
authenticateWithQuickConnect:function
createUserByName:function
Parameters
Returns AxiosPromise<UserDto>
deleteUser:function
- deleteUser(userId: string, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
forgotPassword:function
forgotPasswordPin:function
getCurrentUser:function
- getCurrentUser(options?: any): AxiosPromise<UserDto>
Parameters
Returns AxiosPromise<UserDto>
getPublicUsers:function
- getPublicUsers(options?: any): AxiosPromise<UserDto[]>
Parameters
Returns AxiosPromise<UserDto[]>
getUserById:function
- getUserById(userId: string, options?: any): AxiosPromise<UserDto>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<UserDto>
getUsers:function
- getUsers(isHidden?: boolean, isDisabled?: boolean, options?: any): AxiosPromise<UserDto[]>
Parameters
Optional isHidden: boolean
Optional isDisabled: boolean
Optional options: any
Returns AxiosPromise<UserDto[]>
updateUser:function
- updateUser(userId: string, userDto: UserDto, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
updateUserConfiguration:function
- updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
updateUserEasyPassword:function
- updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
updateUserPassword:function
- updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
updateUserPolicy:function
- updateUserPolicy(userId: string, userPolicy: UserPolicy, options?: any): AxiosPromise<void>
Parameters
userId: string
Optional options: any
Returns AxiosPromise<void>
Const UserApiFp
- UserApiFp(configuration?: Configuration): { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
Parameters
Returns { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
authenticateUser:function
- authenticateUser(userId: string, pw: string, password?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
Parameters
userId: string
pw: string
Optional password: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
authenticateUserByName:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
authenticateWithQuickConnect:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
createUserByName:function
- createUserByName(createUserByName: CreateUserByName, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
deleteUser:function
- deleteUser(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
forgotPassword:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForgotPasswordResult>>
forgotPasswordPin:function
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinRedeemResult>>
getCurrentUser:function
- getCurrentUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
getPublicUsers:function
- getPublicUsers(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
Parameters
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
getUserById:function
- getUserById(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
getUsers:function
- getUsers(isHidden?: boolean, isDisabled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
Parameters
Optional isHidden: boolean
Optional isDisabled: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
updateUser:function
- updateUser(userId: string, userDto: UserDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateUserConfiguration:function
- updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateUserEasyPassword:function
- updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateUserPassword:function
- updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
updateUserPolicy:function
- updateUserPolicy(userId: string, userPolicy: UserPolicy, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const UserLibraryApiAxiosParamCreator
- UserLibraryApiAxiosParamCreator(configuration?: Configuration): { deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>; getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>; getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>; getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>; getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs> }
deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isPlayed: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional limit: number
Optional groupItems: boolean
options: any = {}
Returns Promise<RequestArgs>
getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
options: any = {}
Returns Promise<RequestArgs>
updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, itemId: string, likes?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
itemId: string
Optional likes: boolean
options: any = {}
Returns Promise<RequestArgs>
Const UserLibraryApiFactory
- UserLibraryApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
deleteUserItemRating:function
- deleteUserItemRating(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional options: any
getIntros:function
Parameters
userId: string
itemId: string
Optional options: any
getItem:function
- getItem(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
userId: string
itemId: string
Optional options: any
getLatestMedia:function
- getLatestMedia(userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise<BaseItemDto[]>
Parameters
userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isPlayed: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional limit: number
Optional groupItems: boolean
Optional options: any
Returns AxiosPromise<BaseItemDto[]>
getLocalTrailers:function
- getLocalTrailers(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto[]>
Parameters
userId: string
itemId: string
Optional options: any
Returns AxiosPromise<BaseItemDto[]>
getRootFolder:function
- getRootFolder(userId: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
userId: string
Optional options: any
getSpecialFeatures:function
- getSpecialFeatures(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto[]>
Parameters
userId: string
itemId: string
Optional options: any
Returns AxiosPromise<BaseItemDto[]>
markFavoriteItem:function
- markFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional options: any
unmarkFavoriteItem:function
- unmarkFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional options: any
updateUserItemRating:function
- updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: any): AxiosPromise<UserItemDataDto>
Parameters
userId: string
itemId: string
Optional likes: boolean
Optional options: any
Const UserLibraryApiFp
- UserLibraryApiFp(configuration?: Configuration): { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
Parameters
Returns { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
deleteUserItemRating:function
- deleteUserItemRating(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
getIntros:function
- getIntros(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getItem:function
- getItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getLatestMedia:function
- getLatestMedia(userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
Parameters
userId: string
Optional parentId: string
Optional includeItemTypes: string[]
Optional isPlayed: boolean
Optional enableImages: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional enableUserData: boolean
Optional limit: number
Optional groupItems: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
getLocalTrailers:function
- getLocalTrailers(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
getRootFolder:function
- getRootFolder(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getSpecialFeatures:function
- getSpecialFeatures(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
markFavoriteItem:function
- markFavoriteItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
unmarkFavoriteItem:function
- unmarkFavoriteItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
updateUserItemRating:function
- updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Parameters
userId: string
itemId: string
Optional likes: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
Const UserViewsApiAxiosParamCreator
- UserViewsApiAxiosParamCreator(configuration?: Configuration): { getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>; getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>; getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs> }
getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>
- (userId: string, options?: any): Promise<RequestArgs>
Parameters
userId: string
options: any = {}
Returns Promise<RequestArgs>
getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs>
- (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): Promise<RequestArgs>
Parameters
userId: string
Optional includeExternalContent: boolean
Optional presetViews: string[]
Optional includeHidden: boolean
options: any = {}
Returns Promise<RequestArgs>
Const UserViewsApiFactory
- UserViewsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGroupingOptions: any; getUserViews: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getGroupingOptions: any; getUserViews: any }
getGroupingOptions:function
Parameters
userId: string
Optional options: any
getUserViews:function
- getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
userId: string
Optional includeExternalContent: boolean
Optional presetViews: string[]
Optional includeHidden: boolean
Optional options: any
Const UserViewsApiFp
- UserViewsApiFp(configuration?: Configuration): { getGroupingOptions: any; getUserViews: any }
Parameters
Returns { getGroupingOptions: any; getUserViews: any }
getGroupingOptions:function
- getGroupingOptions(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialViewOptionDto[]>>
Parameters
userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialViewOptionDto[]>>
getUserViews:function
- getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
userId: string
Optional includeExternalContent: boolean
Optional presetViews: string[]
Optional includeHidden: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Const VideoAttachmentsApiAxiosParamCreator
- VideoAttachmentsApiAxiosParamCreator(configuration?: Configuration): { getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs> }
getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs>
- (videoId: string, mediaSourceId: string, index: number, options?: any): Promise<RequestArgs>
Parameters
videoId: string
mediaSourceId: string
index: number
options: any = {}
Returns Promise<RequestArgs>
Const VideoAttachmentsApiFactory
- VideoAttachmentsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAttachment: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getAttachment: any }
getAttachment:function
- getAttachment(videoId: string, mediaSourceId: string, index: number, options?: any): AxiosPromise<any>
Parameters
videoId: string
mediaSourceId: string
index: number
Optional options: any
Returns AxiosPromise<any>
Const VideoAttachmentsApiFp
- VideoAttachmentsApiFp(configuration?: Configuration): { getAttachment: any }
Parameters
Returns { getAttachment: any }
getAttachment:function
- getAttachment(videoId: string, mediaSourceId: string, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
videoId: string
mediaSourceId: string
index: number
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const VideoHlsApiAxiosParamCreator
- VideoHlsApiAxiosParamCreator(configuration?: Configuration): { getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs> }
getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional maxWidth: number
Optional maxHeight: number
Optional enableSubtitlesInManifest: boolean
options: any = {}
Returns Promise<RequestArgs>
Const VideoHlsApiFactory
- VideoHlsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getLiveHlsStream: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getLiveHlsStream: any }
getLiveHlsStream:function
- getLiveHlsStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional maxWidth: number
Optional maxHeight: number
Optional enableSubtitlesInManifest: boolean
Optional options: any
Returns AxiosPromise<any>
Const VideoHlsApiFp
- VideoHlsApiFp(configuration?: Configuration): { getLiveHlsStream: any }
Parameters
Returns { getLiveHlsStream: any }
getLiveHlsStream:function
- getLiveHlsStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional maxWidth: number
Optional maxHeight: number
Optional enableSubtitlesInManifest: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Const VideosApiAxiosParamCreator
- VideosApiAxiosParamCreator(configuration?: Configuration): { deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>; getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs> }
Parameters
Returns { deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>; getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs> }
deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>
- (itemId: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
options: any = {}
Returns Promise<RequestArgs>
getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>
- (itemId: string, userId?: string, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
- (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
options: any = {}
Returns Promise<RequestArgs>
mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs>
- (ids: string[], options?: any): Promise<RequestArgs>
Parameters
ids: string[]
options: any = {}
Returns Promise<RequestArgs>
Const VideosApiFactory
- VideosApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
deleteAlternateSources:function
- deleteAlternateSources(itemId: string, options?: any): AxiosPromise<void>
Parameters
itemId: string
Optional options: any
Returns AxiosPromise<void>
getAdditionalPart:function
Parameters
itemId: string
Optional userId: string
Optional options: any
getVideoStream:function
- getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
getVideoStreamByContainer:function
- getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
headVideoStream:function
- headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
headVideoStreamByContainer:function
- headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns AxiosPromise<any>
mergeVersions:function
- mergeVersions(ids: string[], options?: any): AxiosPromise<void>
Parameters
ids: string[]
Optional options: any
Returns AxiosPromise<void>
Const VideosApiFp
- VideosApiFp(configuration?: Configuration): { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
Parameters
Returns { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
deleteAlternateSources:function
- deleteAlternateSources(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
itemId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
getAdditionalPart:function
- getAdditionalPart(itemId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
itemId: string
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
getVideoStream:function
- getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
getVideoStreamByContainer:function
- getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headVideoStream:function
- headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
Optional container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
headVideoStreamByContainer:function
- headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
Parameters
itemId: string
container: string
Optional _static: boolean
Optional params: string
Optional tag: string
Optional deviceProfileId: string
Optional playSessionId: string
Optional segmentContainer: string
Optional segmentLength: number
Optional minSegments: number
Optional mediaSourceId: string
Optional deviceId: string
Optional audioCodec: string
Optional enableAutoStreamCopy: boolean
Optional allowVideoStreamCopy: boolean
Optional allowAudioStreamCopy: boolean
Optional breakOnNonKeyFrames: boolean
Optional audioSampleRate: number
Optional maxAudioBitDepth: number
Optional audioBitRate: number
Optional audioChannels: number
Optional maxAudioChannels: number
Optional profile: string
Optional level: string
Optional framerate: number
Optional maxFramerate: number
Optional copyTimestamps: boolean
Optional startTimeTicks: number
Optional width: number
Optional height: number
Optional videoBitRate: number
Optional subtitleStreamIndex: number
Optional maxRefFrames: number
Optional maxVideoBitDepth: number
Optional requireAvc: boolean
Optional deInterlace: boolean
Optional requireNonAnamorphic: boolean
Optional transcodingMaxAudioChannels: number
Optional cpuCoreLimit: number
Optional liveStreamId: string
Optional enableMpegtsM2TsMode: boolean
Optional videoCodec: string
Optional subtitleCodec: string
Optional transcodeReasons: string
Optional audioStreamIndex: number
Optional videoStreamIndex: number
Optional streamOptions: {}
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
mergeVersions:function
- mergeVersions(ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Parameters
ids: string[]
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
Const YearsApiAxiosParamCreator
- YearsApiAxiosParamCreator(configuration?: Configuration): { getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>; getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
Parameters
Returns { getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>; getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>
- (year: number, userId?: string, options?: any): Promise<RequestArgs>
Parameters
year: number
Optional userId: string
options: any = {}
Returns Promise<RequestArgs>
getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
- (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
Parameters
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
Optional sortBy: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional recursive: boolean
Optional enableImages: boolean
options: any = {}
Returns Promise<RequestArgs>
Const YearsApiFactory
- YearsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getYear: any; getYears: any }
Parameters
Optional basePath: string
Optional axios: AxiosInstance
Returns { getYear: any; getYears: any }
getYear:function
- getYear(year: number, userId?: string, options?: any): AxiosPromise<BaseItemDto>
Parameters
year: number
Optional userId: string
Optional options: any
getYears:function
- getYears(startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
Parameters
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
Optional sortBy: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional recursive: boolean
Optional enableImages: boolean
Optional options: any
Const YearsApiFp
- YearsApiFp(configuration?: Configuration): { getYear: any; getYears: any }
Parameters
Returns { getYear: any; getYears: any }
getYear:function
- getYear(year: number, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
Parameters
year: number
Optional userId: string
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
getYears:function
- getYears(startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
Parameters
Optional startIndex: number
Optional limit: number
Optional sortOrder: SortOrder[]
Optional parentId: string
Optional excludeItemTypes: string[]
Optional includeItemTypes: string[]
Optional mediaTypes: string[]
Optional sortBy: string[]
Optional enableUserData: boolean
Optional imageTypeLimit: number
Optional enableImageTypes: ImageType[]
Optional userId: string
Optional recursive: boolean
Optional enableImages: boolean
Optional options: any
Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
ActivityLogApi - axios parameter creator